REST API Reference

Ready to explore

Select an endpoint

Open a resource, choose a tag, and pick an endpoint to view its request and response details here.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/academy/admin/registrations

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/academy/admin/registrations

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/academy/admin/registrations

Parameters

Query parameters

Name	Type	Required	Description
`pagesize`	integer	No	Number of results per page
`page`	integer	No	Page number
`contentType`	array of string	No	Filter by content types
`status`	array of string	No	Filter by registration status

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`data`	array of object	Yes	The data of the curricularegistrationsresponse.
`page`	integer	Yes	Current page number of the result set.
`page_size`	integer	Yes	Number of items per page.
`total_count`	integer (int64)	Yes	Total number of items available.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/academy/admin/summary

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/academy/admin/summary

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/academy/admin/summary

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/academy/certificates/{certificateId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/academy/certificates/{certificateId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/academy/certificates/{certificateId}

Parameters

Path parameters

Name	Type	Required	Description
`certificateId`	string	Yes	The ID of the certificate to retrieve

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`description`	string	Yes	Description of the certificate
`expirationDate`	string (date-time)	No	Date when the certificate expires. Dynamically calculated from issued_date and expires_in; not specified by instructors.
`expiresIn`	integer	No	Number of months after which the certificate expires
`id`	string (uuid)	Yes	Unique identifier for the certificate
`issuedDate`	string (date-time)	Yes	Date when the certificate was issued
`issuingAuthorities`	array of object	Yes	List of issuing authorities for the certificate
`orgId`	string (uuid)	Yes	A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
`recipientId`	string (uuid)	Yes	ID of the recipient (user) who received the certificate
`recipientName`	string	Yes	Name of the recipient (user) who received the certificate
`title`	string	Yes	Title of the certificate

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/academy/curricula

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/academy/curricula

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/academy/curricula

Parameters

Query parameters

Name	Type	Required	Description
`contentType`	array of string	No	Filter content by content types
`visibility`	array of string	No	Filter content by visibility (public/private)
`level`	array of string	No	Filter content by difficulty level
`orgId`	array of string	No	Filter content by organization IDs
`category`	array of string	No	Filter content by categories
`status`	array of string	No	Filter by registration status
`search`	string	No	Search content by title
`sort`	string	No	Sort results by a specific field (e.g., title, createdAt)
`order`	string	No	Order of sorting (asc or desc)
`pagesize`	integer	No	Number of results per page
`page`	integer	No	Page number

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`data`	array of object	Yes	The data of the academycurriculawithmetricslistresponse.
`total`	integer	Yes	Total number of Curricula

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/academy/curricula

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/academy/curricula

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/academy/curricula

Request body

application/json Required

Field	Type	Required	Description
`access_expires_at`	string	No	Expiry time for curricula access
`access_status`	string	Yes	Current access status of the curricula
`badge_id`	string (uuid)	No	ID of the badge to be awarded on completion of this curricula
`metadata`	object	Yes	Additional metadata about the Curricula
`org_id`	string	Yes	Organization ID that owns this learning path
`team_id`	string (uuid)	Yes	A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
`title`	string	Yes	Title of the curricula
`type`	string	Yes	Type of the curricula
`workspace_id`	string	Yes	ID of the workspace to which this Curricula belongs

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

AcademyCurricula entity schema.

Field	Type	Required	Description
`badge_id`	string (uuid)	No	ID of the badge to be awarded on completion of this curricula
`created_at`	string	Yes	When the Curricula item was created
`deleted_at`	string	Yes	No description provided.
`id`	string (uuid)	Yes	Id of the Curricula
`invite_id`	string	No	ID of the invite associated with this Curricula
`level`	string	Yes	Level of the Curricula
`metadata`	object	Yes	Additional metadata about the Curricula
`org_id`	string	Yes	Organization ID that owns this learning path
`slug`	string	Yes	slug of the Curricula
`status`	string	Yes	Status of the Curricula
`type`	string	Yes	No description provided.
`updated_at`	string	Yes	When the Curricula was last updated
`visibility`	string	Yes	Visibility of the Curricula
`workspace_id`	string	No	ID of the workspace to which this Curricula belongs

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/academy/curricula/registered

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/academy/curricula/registered

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/academy/curricula/registered

Parameters

Query parameters

Name	Type	Required	Description
`contentType`	array of string	No	Filter content by content types
`orgId`	array of string	No	Filter content by organization IDs

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`data`	array of object	Yes	The data of the academycurriculalistresponse.
`total`	integer	Yes	Total number of Curricula

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/academy/curricula/registrations/{id}/withdraw

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/academy/curricula/registrations/{id}/withdraw

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/academy/curricula/registrations/{id}/withdraw

Parameters

Path parameters

Name	Type	Required	Description
`id`	string	Yes	The ID of the curricula

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`certificate`	object	Yes	Issued certificate for completing the curricula under registration
`content_id`	string (uuid)	Yes	ID of the course content
`created_at`	string (date-time)	Yes	When the registration was created
`deleted_at`	string (date-time)	No	Timestamp when the resource was deleted.
`id`	string (uuid)	Yes	A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
`metadata`	object	Yes	Additional metadata about the registration
`org_id`	string (uuid)	Yes	A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
`status`	string	Yes	Status of the user’s course registration
`updated_at`	string (date-time)	Yes	When the registration was updated
`user_id`	string (uuid)	Yes	A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/academy/curricula/{id}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/academy/curricula/{id}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/academy/curricula/{id}

Parameters

Path parameters

Name	Type	Required	Description
`id`	string	Yes	The ID of the curricula

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

AcademyCurricula entity schema.

Field	Type	Required	Description
`badge_id`	string (uuid)	No	ID of the badge to be awarded on completion of this curricula
`created_at`	string	Yes	When the Curricula item was created
`deleted_at`	string	Yes	No description provided.
`id`	string (uuid)	Yes	Id of the Curricula
`invitation`	object	No	Invitation entity schema.
`invite_id`	string	No	ID of the invite associated with this Curricula
`level`	string	Yes	Level of the Curricula
`metadata`	object	Yes	Additional metadata about the Curricula
`org_id`	string	Yes	Organization ID that owns this learning path
`registration_count`	number	Yes	Number of registrations associated with this curriculum.
`slug`	string	Yes	slug of the Curricula
`status`	string	Yes	Status of the Curricula
`type`	string	Yes	No description provided.
`updated_at`	string	Yes	When the Curricula was last updated
`visibility`	string	Yes	Visibility of the Curricula
`workspace_id`	string	No	ID of the workspace to which this Curricula belongs

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/academy/curricula/{id}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/academy/curricula/{id}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/academy/curricula/{id}

Parameters

Path parameters

Name	Type	Required	Description
`id`	string	Yes	The ID of the curricula

Request body

application/json Required

Field	Type	Required	Description
`access_expires_at`	string	No	Expiry time for curricula access
`access_status`	string	Yes	Current access status of the curricula
`badge_id`	string (uuid)	No	ID of the badge to be awarded on completion of this curricula
`metadata`	object	Yes	Additional metadata about the Curricula
`org_id`	string	Yes	Organization ID that owns this learning path
`team_id`	string (uuid)	Yes	A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
`title`	string	Yes	Title of the curricula
`type`	string	Yes	Type of the curricula
`workspace_id`	string	Yes	ID of the workspace to which this Curricula belongs

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

AcademyCurricula entity schema.

Field	Type	Required	Description
`badge_id`	string (uuid)	No	ID of the badge to be awarded on completion of this curricula
`created_at`	string	Yes	When the Curricula item was created
`deleted_at`	string	Yes	No description provided.
`id`	string (uuid)	Yes	Id of the Curricula
`invitation`	object	No	Invitation entity schema.
`invite_id`	string	No	ID of the invite associated with this Curricula
`level`	string	Yes	Level of the Curricula
`metadata`	object	Yes	Additional metadata about the Curricula
`org_id`	string	Yes	Organization ID that owns this learning path
`registration_count`	number	Yes	Number of registrations associated with this curriculum.
`slug`	string	Yes	slug of the Curricula
`status`	string	Yes	Status of the Curricula
`type`	string	Yes	No description provided.
`updated_at`	string	Yes	When the Curricula was last updated
`visibility`	string	Yes	Visibility of the Curricula
`workspace_id`	string	No	ID of the workspace to which this Curricula belongs

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/academy/curricula/{id}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/academy/curricula/{id}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/academy/curricula/{id}

Parameters

Path parameters

Name	Type	Required	Description
`id`	string	Yes	The ID of the curricula

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/academy/register

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/academy/register

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/academy/register

Request body

application/json Required

Field	Type	Required	Description
`contentId`	string (uuid)	Yes	ID of the academy content to register for
`contentType`	string	No	No description provided.
`user_id`	string (uuid)	Yes	ID of the user registering for the content.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`certificate`	object	Yes	Issued certificate for completing the curricula under registration
`content_id`	string (uuid)	Yes	ID of the course content
`created_at`	string (date-time)	Yes	When the registration was created
`deleted_at`	string (date-time)	No	Timestamp when the resource was deleted.
`id`	string (uuid)	Yes	A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
`metadata`	object	Yes	Additional metadata about the registration
`org_id`	string (uuid)	Yes	A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
`status`	string	Yes	Status of the user’s course registration
`updated_at`	string (date-time)	Yes	When the registration was updated
`user_id`	string (uuid)	Yes	A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/academy/registrations/test-sessions/start

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/academy/registrations/test-sessions/start

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/academy/registrations/test-sessions/start

Request body

application/json Required

Field	Type	Required	Description
`registrationId`	string (uuid)	Yes	ID of the associated registration.
`testAbsPath`	string	Yes	The test abs path of the starttestrequest.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`date`	string (date)	Yes	The date of the quiz.
`description`	string	Yes	Description of the quiz.
`draft`	boolean	Yes	The draft of the quiz.
`filePath`	string	Yes	The file path of the quiz.
`final`	boolean	Yes	Indicates if the quiz is final . i.e this quiz will used to evaluate the completion of parent section eg course , module , learning path
`id`	string (uuid)	Yes	Quiz ID.
`lastmod`	string (date)	Yes	The lastmod of the quiz.
`layout`	string	Yes	The layout of the quiz.
`maxAttempts`	integer	Yes	Maximum number of attempts allowed for the quiz. A value of 0 indicates unlimited attempts.
`nextPage`	object	Yes	No description provided.
`org_id`	string (uuid)	Yes	Organization ID that owns this quiz
`parent`	object	No	No description provided.
`passPercentage`	number (float)	Yes	The pass percentage of the quiz.
`permalink`	string	Yes	The permalink of the quiz.
`prerequisites`	array of object	Yes	The prerequisites of the quiz.
`questions`	array of object	Yes	The questions of the quiz.
`relPermalink`	string	Yes	The rel permalink of the quiz.
`section`	string	Yes	The section of the quiz.
`slug`	string	Yes	The slug of the quiz.
`timeLimit`	integer	Yes	Time limit for the quiz in minutes. A value of 0 indicates no time limit.
`title`	string	Yes	The title of the quiz.
`totalMarks`	integer	Yes	The total marks of the quiz.
`totalQuestions`	integer	Yes	The total questions of the quiz.
`totalQuestionSets`	integer	Yes	The total question sets of the quiz.
`totalQuestionsInBank`	integer	Yes	The total questions in bank of the quiz.
`type`	string	Yes	Type of the resource.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/academy/registrations/test-sessions/submit

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/academy/registrations/test-sessions/submit

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/academy/registrations/test-sessions/submit

Request body

application/json Required

Field	Type	Required	Description
`answers`	array of object	Yes	The answers of the quizsubmission.
`quizAbsPath`	string	Yes	The quiz abs path of the quizsubmission.
`registrationId`	string (uuid)	Yes	ID of the associated registration.
`testSessionId`	string (uuid)	Yes	A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
`user_id`	string (uuid)	Yes	ID of the user who owns or created this resource.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`attemptedAt`	string (date-time)	Yes	The attempted at of the quizevaluationresult.
`attempts`	integer	Yes	The attempts of the quizevaluationresult.
`correctSubmissions`	object	Yes	The correct submissions of the quizevaluationresult.
`passed`	boolean	Yes	The passed of the quizevaluationresult.
`passPercentage`	number (float)	Yes	The pass percentage of the quizevaluationresult.
`percentageScored`	number (float)	Yes	The percentage scored of the quizevaluationresult.
`quiz`	object	Yes	No description provided.
`score`	integer	Yes	The score of the quizevaluationresult.
`totalMarks`	integer	Yes	The total marks of the quizevaluationresult.

Field	Type	Required	Description
`details`	string	No	The details of the errorresponse.
`error`	string	No	The error of the errorresponse.

Field	Type	Required	Description
`details`	string	No	The details of the errorresponse.
`error`	string	No	The error of the errorresponse.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/academy/registrations/tests

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/academy/registrations/tests

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/academy/registrations/tests

Parameters

Query parameters

Name	Type	Required	Description
`absPath`	string	Yes	The absolute path of the test to retrieve

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`date`	string (date)	Yes	The date of the quiz.
`description`	string	Yes	Description of the quiz.
`draft`	boolean	Yes	The draft of the quiz.
`filePath`	string	Yes	The file path of the quiz.
`final`	boolean	Yes	Indicates if the quiz is final . i.e this quiz will used to evaluate the completion of parent section eg course , module , learning path
`id`	string (uuid)	Yes	Quiz ID.
`lastmod`	string (date)	Yes	The lastmod of the quiz.
`layout`	string	Yes	The layout of the quiz.
`maxAttempts`	integer	Yes	Maximum number of attempts allowed for the quiz. A value of 0 indicates unlimited attempts.
`nextPage`	object	Yes	No description provided.
`org_id`	string (uuid)	Yes	Organization ID that owns this quiz
`parent`	object	No	No description provided.
`passPercentage`	number (float)	Yes	The pass percentage of the quiz.
`permalink`	string	Yes	The permalink of the quiz.
`prerequisites`	array of object	Yes	The prerequisites of the quiz.
`questions`	array of object	Yes	The questions of the quiz.
`relPermalink`	string	Yes	The rel permalink of the quiz.
`section`	string	Yes	The section of the quiz.
`slug`	string	Yes	The slug of the quiz.
`timeLimit`	integer	Yes	Time limit for the quiz in minutes. A value of 0 indicates no time limit.
`title`	string	Yes	The title of the quiz.
`totalMarks`	integer	Yes	The total marks of the quiz.
`totalQuestions`	integer	Yes	The total questions of the quiz.
`totalQuestionSets`	integer	Yes	The total question sets of the quiz.
`totalQuestionsInBank`	integer	Yes	The total questions in bank of the quiz.
`type`	string	Yes	Type of the resource.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/academy/registrations/{contentId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/academy/registrations/{contentId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/academy/registrations/{contentId}

Parameters

Path parameters

Name	Type	Required	Description
`contentId`	string	Yes	The ID of the content to retrieve registration data for

Query parameters

Name	Type	Required	Description
`status`	string	No	Filter registrations by status (e.g., registered, completed)

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`certificate`	object	Yes	Issued certificate for completing the curricula under registration
`content_id`	string (uuid)	Yes	ID of the course content
`created_at`	string (date-time)	Yes	When the registration was created
`deleted_at`	string (date-time)	No	Timestamp when the resource was deleted.
`id`	string (uuid)	Yes	A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
`metadata`	object	Yes	Additional metadata about the registration
`org_id`	string (uuid)	Yes	A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
`status`	string	Yes	Status of the user’s course registration
`updated_at`	string (date-time)	Yes	When the registration was updated
`user_id`	string (uuid)	Yes	A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/academy/registrations/{id}/test-sessions

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/academy/registrations/{id}/test-sessions

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/academy/registrations/{id}/test-sessions

Parameters

Path parameters

Name	Type	Required	Description
`id`	string	Yes	The ID of the registration to retrieve tests for

Query parameters

Name	Type	Required	Description
`page`	string	No	Get responses by page
`pagesize`	string	No	Get responses by pagesize
`testAbsPath`	string	No	Filter tests by absolute path

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/academy/registrations/{registrationId}/progress-tracker/update-current-item

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/academy/registrations/{registrationId}/progress-tracker/update-current-item

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/academy/registrations/{registrationId}/progress-tracker/update-current-item

Parameters

Path parameters

Name	Type	Required	Description
`registrationId`	string	Yes	The ID of the registration

Request body

application/json Required

Field	Type	Required	Description
`contentType`	string	Yes	No description provided.
`itemData`	object	Yes	No description provided.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`contentType`	string	No	No description provided.
`itemData`	object	No	No description provided.
`message`	string	No	The message of the updatecurrentitemprogressresponse.
`progressTracker`	object	No	No description provided.
`registrationId`	string (uuid)	No	ID of the associated registration.

Field	Type	Required	Description
`details`	string	No	The details of the errorresponse.
`error`	string	No	The error of the errorresponse.

Field	Type	Required	Description
`details`	string	No	The details of the errorresponse.
`error`	string	No	The error of the errorresponse.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/academy/{type}/{orgId}/{slug}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/academy/{type}/{orgId}/{slug}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/academy/{type}/{orgId}/{slug}

Parameters

Path parameters

Name	Type	Required	Description
`type`	string	Yes	No description provided.
`orgId`	string	Yes	No description provided.
`slug`	string	Yes	No description provided.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

AcademyCurricula entity schema.

Field	Type	Required	Description
`badge_id`	string (uuid)	No	ID of the badge to be awarded on completion of this curricula
`created_at`	string	Yes	When the Curricula item was created
`deleted_at`	string	Yes	No description provided.
`id`	string (uuid)	Yes	Id of the Curricula
`invite_id`	string	No	ID of the invite associated with this Curricula
`level`	string	Yes	Level of the Curricula
`metadata`	object	Yes	Additional metadata about the Curricula
`org_id`	string	Yes	Organization ID that owns this learning path
`slug`	string	Yes	slug of the Curricula
`status`	string	Yes	Status of the Curricula
`type`	string	Yes	No description provided.
`updated_at`	string	Yes	When the Curricula was last updated
`visibility`	string	Yes	Visibility of the Curricula
`workspace_id`	string	No	ID of the workspace to which this Curricula belongs

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/auth/key/{keyId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/auth/key/{keyId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/auth/key/{keyId}

Parameters

Path parameters

Name	Type	Required	Description
`keyId`	string (uuid)	Yes	Key ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Represents an authorization key used for access control.

Field	Type	Required	Description
`id`	string (uuid)	Yes	A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
`owner`	string (uuid)	Yes	A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
`function`	string	Yes	Operation permitted by the key.
`category`	string	Yes	Category for the key.
`subcategory`	string	Yes	Subcategory for the key.
`description`	string	Yes	Human readable description of the key.
`created_at`	string (date-time)	Yes	Timestamp when the resource was created.
`updated_at`	string (date-time)	Yes	Timestamp when the resource was updated.
`deleted_at`	string (date-time)	No	SQL null Timestamp to handle null values of time.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/auth/key/{keyId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/auth/key/{keyId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/auth/key/{keyId}

Parameters

Path parameters

Name	Type	Required	Description
`keyId`	string (uuid)	Yes	Key ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/auth/keychains

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/auth/keychains

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/auth/keychains

Parameters

Query parameters

Name	Type	Required	Description
`page`	string	No	Get responses by page
`pagesize`	string	No	Get responses by pagesize
`search`	string	No	Get responses that match search param value
`order`	string	No	Get ordered responses

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`page`	integer	Yes	No description provided.
`page_size`	integer	Yes	No description provided.
`total_count`	integer	Yes	No description provided.
`keychains`	array of object	Yes	The keychains of the keychainpage.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/auth/keychains

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/auth/keychains

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/auth/keychains

Request body

application/json Required

Input payload for creating or updating a keychain.

Field	Type	Required	Description
`name`	string	Yes	Name of the keychain.
`owner`	string (uuid)	No	Owner of the keychain.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Represents a collection of keys.

Field	Type	Required	Description
`id`	string (uuid)	Yes	Unique identifier for the keychain.
`name`	string	Yes	Name of the keychain.
`owner`	string (uuid)	Yes	Owner of the keychain.
`created_at`	string (date-time)	Yes	Timestamp when the resource was created.
`updated_at`	string (date-time)	Yes	Timestamp when the resource was updated.
`deleted_at`	string (date-time)	No	SQL null Timestamp to handle null values of time.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/auth/keychains/{keychainId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/auth/keychains/{keychainId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/auth/keychains/{keychainId}

Parameters

Path parameters

Name	Type	Required	Description
`keychainId`	string (uuid)	Yes	Keychain ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Represents a collection of keys.

Field	Type	Required	Description
`id`	string (uuid)	Yes	Unique identifier for the keychain.
`name`	string	Yes	Name of the keychain.
`owner`	string (uuid)	Yes	Owner of the keychain.
`created_at`	string (date-time)	Yes	Timestamp when the resource was created.
`updated_at`	string (date-time)	Yes	Timestamp when the resource was updated.
`deleted_at`	string (date-time)	No	SQL null Timestamp to handle null values of time.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/auth/keychains/{keychainId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/auth/keychains/{keychainId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/auth/keychains/{keychainId}

Parameters

Path parameters

Name	Type	Required	Description
`keychainId`	string (uuid)	Yes	Keychain ID

Request body

application/json Required

Input payload for creating or updating a keychain.

Field	Type	Required	Description
`name`	string	Yes	Name of the keychain.
`owner`	string (uuid)	No	Owner of the keychain.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Represents a collection of keys.

Field	Type	Required	Description
`id`	string (uuid)	Yes	Unique identifier for the keychain.
`name`	string	Yes	Name of the keychain.
`owner`	string (uuid)	Yes	Owner of the keychain.
`created_at`	string (date-time)	Yes	Timestamp when the resource was created.
`updated_at`	string (date-time)	Yes	Timestamp when the resource was updated.
`deleted_at`	string (date-time)	No	SQL null Timestamp to handle null values of time.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/auth/keychains/{keychainId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/auth/keychains/{keychainId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/auth/keychains/{keychainId}

Parameters

Path parameters

Name	Type	Required	Description
`keychainId`	string (uuid)	Yes	Keychain ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/auth/keychains/{keychainId}/keys

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/auth/keychains/{keychainId}/keys

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/auth/keychains/{keychainId}/keys

Parameters

Path parameters

Name	Type	Required	Description
`keychainId`	string (uuid)	Yes	Keychain ID

Query parameters

Name	Type	Required	Description
`page`	string	No	Get responses by page
`pagesize`	string	No	Get responses by pagesize
`search`	string	No	Get responses that match search param value
`order`	string	No	Get ordered responses

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`page`	integer	Yes	No description provided.
`page_size`	integer	Yes	No description provided.
`total_count`	integer	Yes	No description provided.
`keys`	array of object	Yes	The keys of the keypage.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/auth/keychains/{keychainId}/{keyId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/auth/keychains/{keychainId}/{keyId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/auth/keychains/{keychainId}/{keyId}

Parameters

Path parameters

Name	Type	Required	Description
`keychainId`	string (uuid)	Yes	Keychain ID
`keyId`	string (uuid)	Yes	Key ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/auth/keychains/{keychainId}/{keyId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/auth/keychains/{keychainId}/{keyId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/auth/keychains/{keychainId}/{keyId}

Parameters

Path parameters

Name	Type	Required	Description
`keychainId`	string (uuid)	Yes	Keychain ID
`keyId`	string (uuid)	Yes	Key ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/auth/keys

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/auth/keys

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/auth/keys

Parameters

Query parameters

Name	Type	Required	Description
`page`	string	No	Get responses by page
`pagesize`	string	No	Get responses by pagesize
`search`	string	No	Get responses that match search param value
`order`	string	No	Get ordered responses

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`page`	integer	Yes	No description provided.
`page_size`	integer	Yes	No description provided.
`total_count`	integer	Yes	No description provided.
`keys`	array of object	Yes	The keys of the keypage.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/auth/keys

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/auth/keys

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/auth/keys

Request body

application/json Required

Payload for creating or updating a key.

Field	Type	Required	Description
`id`	string (uuid)	No	A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
`function`	string	No	Operation permitted by the key.
`category`	string	No	Category for the key.
`subcategory`	string	No	Subcategory for the key.
`description`	string	No	Human readable description of the key.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Represents an authorization key used for access control.

Field	Type	Required	Description
`id`	string (uuid)	Yes	A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
`owner`	string (uuid)	Yes	A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
`function`	string	Yes	Operation permitted by the key.
`category`	string	Yes	Category for the key.
`subcategory`	string	Yes	Subcategory for the key.
`description`	string	Yes	Human readable description of the key.
`created_at`	string (date-time)	Yes	Timestamp when the resource was created.
`updated_at`	string (date-time)	Yes	Timestamp when the resource was updated.
`deleted_at`	string (date-time)	No	SQL null Timestamp to handle null values of time.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/catalog/content/classes

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/catalog/content/classes

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/catalog/content/classes

Parameters

Query parameters

Name	Type	Required	Description
`page`	string	No	Get responses by page
`pagesize`	string	No	Get responses by pagesize

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`class`	string	No	The class of the catalogcontentclass.
`description`	string	No	Description of the catalogcontentclass.

Authentication

No authentication required

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/catalog/content/{type}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/catalog/content/{type}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/catalog/content/{type}

Parameters

Path parameters

Name	Type	Required	Description
`type`	string	Yes	No description provided.

Query parameters

Name	Type	Required	Description
`page`	string	No	Get responses by page
`pagesize`	string	No	Get responses by pagesize
`search`	string	No	Get responses that match search param value
`order`	string	No	Get ordered responses
`type`	string	No	No description provided.
`technology`	string	No	No description provided.
`metrics`	boolean	No	No description provided.
`class`	string	No	No description provided.
`userId`	string	No	No description provided.
`orgId`	string	No	No description provided.
`workspaceId`	string	No	No description provided.
`teamId`	string	No	No description provided.
`populate`	boolean	No	No description provided.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`categoryCount`	array of object	No	The category count of the catalogcontentpage.
`filters`	array of object	No	The filters of the catalogcontentpage.
`modelsCount`	array of object	No	The models count of the catalogcontentpage.
`page`	integer	No	Current page number of the result set.
`page_size`	integer	No	Number of items per page.
`patterns`	array of object	No	The patterns of the catalogcontentpage.
`total_count`	integer	No	Total number of items available.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/catalog/content/{type}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/catalog/content/{type}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/catalog/content/{type}

Parameters

Path parameters

Name	Type	Required	Description
`type`	string	Yes	No description provided.

Request body

application/json Required

Schema: object

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/catalog/content/{type}/unpublish

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/catalog/content/{type}/unpublish

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/catalog/content/{type}/unpublish

Parameters

Path parameters

Name	Type	Required	Description
`type`	string	Yes	No description provided.

Request body

application/json Required

Schema: object

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/catalog/requests

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/catalog/requests

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/catalog/requests

Parameters

Query parameters

Name	Type	Required	Description
`page`	string	No	Get responses by page
`pagesize`	string	No	Get responses by pagesize
`search`	string	No	Get responses that match search param value
`order`	string	No	Get ordered responses
`filter`	string	No	No description provided.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`catalogRequests`	array of object	No	The catalog requests of the catalogrequestspage.
`page`	integer	No	Current page number of the result set.
`page_size`	integer	No	Number of items per page.
`total_count`	integer	No	Total number of items available.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/catalog/requests/approve

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/catalog/requests/approve

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/catalog/requests/approve

Request body

application/json Required

Schema: object

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/catalog/requests/deny

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/catalog/requests/deny

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/catalog/requests/deny

Request body

application/json Required

Schema: object

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/content/filters/clone/{id}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/content/filters/clone/{id}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/content/filters/clone/{id}

Parameters

Path parameters

Name	Type	Required	Description
`id`	string (uuid)	Yes	Design (Pattern) ID

Request body

application/json Required

Schema: object

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/content/filters/{id}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/content/filters/{id}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/content/filters/{id}

Parameters

Path parameters

Name	Type	Required	Description
`id`	string (uuid)	Yes	Design (Pattern) ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/content/patterns

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/content/patterns

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/content/patterns

Parameters

Query parameters

Name	Type	Required	Description
`page`	string	No	Get responses by page
`pagesize`	string	No	Get responses by pagesize
`search`	string	No	Get responses that match search param value
`order`	string	No	Get ordered responses
`visibility`	string	No	Filter by visibility (public, private, published)
`userId`	string	No	UUID of User. Pass userId for fetching public and published designs.
`orgId`	string	No	User’s organization ID.
`metrics`	boolean	No	No description provided.
`workspaceId`	string	No	No description provided.
`populate`	boolean	No	No description provided.
`shared`	boolean	No	No description provided.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`page`	integer	No	Current page number of the result set.
`page_size`	integer	No	Number of items per page.
`patterns`	array of object	No	The patterns of the mesherypatternpage.
`resultType`	string	No	The result type of the mesherypatternpage.
`total_count`	integer	No	Total number of items available.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/content/patterns

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/content/patterns

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/content/patterns

Request body

application/json Required

Field	Type	Required	Description
`name`	string	No	Name of the mesherypatternrequestbody.
`path`	string	No	No description provided.
`patternData`	object	No	No description provided.
`save`	boolean	No	The save of the mesherypatternrequestbody.
`url`	string (uri)	No	endpoint

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`catalogData`	object	No	No description provided.
`created_at`	string (date-time)	No	No description provided.
`id`	string (uuid)	No	No description provided.
`location`	object	No	No description provided.
`name`	string	No	No description provided.
`patternFile`	object	No	Designs are your primary tool for collaborative authorship of your infrastructure, workflow, and processes.
`updated_at`	string (date-time)	No	No description provided.
`user_id`	string (uuid)	No	No description provided.
`visibility`	string	No	No description provided.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/content/patterns/clone/{id}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/content/patterns/clone/{id}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/content/patterns/clone/{id}

Parameters

Path parameters

Name	Type	Required	Description
`id`	string (uuid)	Yes	Design (Pattern) ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`catalogData`	object	No	No description provided.
`created_at`	string (date-time)	No	No description provided.
`id`	string (uuid)	No	No description provided.
`location`	object	No	No description provided.
`name`	string	No	No description provided.
`patternFile`	object	No	Designs are your primary tool for collaborative authorship of your infrastructure, workflow, and processes.
`updated_at`	string (date-time)	No	No description provided.
`user_id`	string (uuid)	No	No description provided.
`visibility`	string	No	No description provided.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/content/patterns/delete

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/content/patterns/delete

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/content/patterns/delete

Request body

application/json Required

Field	Type	Required	Description
`patterns`	array of object	No	The patterns of the mesherypatterndeleterequestbody.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/content/patterns/download/{id}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/content/patterns/download/{id}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/content/patterns/download/{id}

Parameters

Path parameters

Name	Type	Required	Description
`id`	string (uuid)	Yes	Design (Pattern) ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/content/patterns/resource

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/content/patterns/resource

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/content/patterns/resource

Parameters

Query parameters

Name	Type	Required	Description
`page`	string	No	Get responses by page
`pagesize`	string	No	Get responses by pagesize
`search`	string	No	Get responses that match search param value
`order`	string	No	Get ordered responses

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/content/patterns/resource

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/content/patterns/resource

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/content/patterns/resource

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/content/patterns/resource/{id}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/content/patterns/resource/{id}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/content/patterns/resource/{id}

Parameters

Path parameters

Name	Type	Required	Description
`id`	string (uuid)	Yes	Design (Pattern) ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/content/patterns/resource/{id}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/content/patterns/resource/{id}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/content/patterns/resource/{id}

Parameters

Path parameters

Name	Type	Required	Description
`id`	string (uuid)	Yes	Design (Pattern) ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/content/patterns/upload/{id}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/content/patterns/upload/{id}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/content/patterns/upload/{id}

Parameters

Path parameters

Name	Type	Required	Description
`id`	string (uuid)	Yes	Design (Pattern) ID

Request body

multipart/form-data Required

Choose the method you prefer to upload your design file. Select ‘File Upload’ if you have the file on your local system, or ‘URL Import’ if you have the file hosted online.

Field	Type	Required	Description
`file`	string (file)	No	Supported formats: Kubernetes Manifests, Helm Charts, Docker Compose, and Meshery Designs. See Import Designs Documentation for details
`fileName`	string	No	The name of the pattern file being imported.
`name`	string	No	Provide a name for your design file. This name will help you identify the file more easily. You can also change the name of your design after importing it.
`url`	string (uri)	No	Provide the URL of the file you want to import. This should be a direct URL to a single file, for example: https://raw.github.com/your-design-file.yaml. Also, ensure that design is in a supported format: Kubernetes Manifest, Helm Chart, Docker Compose, or Meshery Design. See Import Designs Documentation for details

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/content/patterns/{id}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/content/patterns/{id}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/content/patterns/{id}

Parameters

Path parameters

Name	Type	Required	Description
`id`	string (uuid)	Yes	Design (Pattern) ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`catalogData`	object	No	No description provided.
`created_at`	string (date-time)	No	No description provided.
`id`	string (uuid)	No	No description provided.
`location`	object	No	No description provided.
`name`	string	No	No description provided.
`patternFile`	object	No	Designs are your primary tool for collaborative authorship of your infrastructure, workflow, and processes.
`updated_at`	string (date-time)	No	No description provided.
`user_id`	string (uuid)	No	No description provided.
`visibility`	string	No	No description provided.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/content/patterns/{id}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/content/patterns/{id}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/content/patterns/{id}

Parameters

Path parameters

Name	Type	Required	Description
`id`	string (uuid)	Yes	Design (Pattern) ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/content/views

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/content/views

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/content/views

Parameters

Query parameters

Name	Type	Required	Description
`search`	string	No	Get responses that match search param value
`order`	string	No	Get ordered responses
`page`	string	No	Get responses by page
`pagesize`	string	No	Get responses by pagesize
`filter`	string	No	JSON-encoded filter string for assignment and soft-delete filters.
`shared`	boolean	No	When true, include views shared with the user.
`visibility`	string	No	Filter by visibility level (public, private).
`orgId`	string	No	Organization ID to scope the request.
`userId`	string	No	UUID of the user whose views to retrieve.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Paginated list of views with location enrichment.

Field	Type	Required	Description
`page`	integer	No	No description provided.
`page_size`	integer	No	No description provided.
`total_count`	integer	No	No description provided.
`views`	array of object	No	Views in this page, enriched with workspace and organization context.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/content/views

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/content/views

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/content/views

Request body

application/json Required

Body for creating or updating a view

Payload for creating or updating a view.

Field	Type	Required	Description
`filters`	object	No	Filter configuration for this view.
`metadata`	object	No	Metadata associated with the view.
`name`	string	Yes	Display name of the view.
`visibility`	string	No	Visibility level of the view.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

A saved view with filters and metadata that defines a customized perspective of Meshery resources. Learn more at https://docs.meshery.io/concepts/logical/views

Field	Type	Required	Description
`id`	string (uuid)	Yes	Unique identifier for the view.
`name`	string	Yes	Display name of the view.
`visibility`	string	Yes	Visibility level of the view.
`filters`	object	No	Filter configuration that defines which resources this view displays.
`metadata`	object	No	Additional metadata associated with the view.
`user_id`	string (uuid)	Yes	ID of the user who created the view.
`created_at`	string (date-time)	Yes	Timestamp when the view was created.
`updated_at`	string (date-time)	Yes	Timestamp when the view was last updated.
`deleted_at`	string \| null (date-time)	No	Timestamp when the view was soft deleted. Null while the view remains active.

Example response

{
  "created_at": "0001-01-01T00:00:00Z",
  "deleted_at": null,
  "filters": {},
  "id": "00000000-0000-0000-0000-000000000000",
  "metadata": {},
  "name": "My Kubernetes View",
  "updated_at": "0001-01-01T00:00:00Z",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "visibility": "private"
}

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/content/views/{viewId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/content/views/{viewId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/content/views/{viewId}

Parameters

Path parameters

Name	Type	Required	Description
`viewId`	string (uuid)	Yes	View ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

A saved view with filters and metadata that defines a customized perspective of Meshery resources. Learn more at https://docs.meshery.io/concepts/logical/views

Field	Type	Required	Description
`id`	string (uuid)	Yes	Unique identifier for the view.
`name`	string	Yes	Display name of the view.
`visibility`	string	Yes	Visibility level of the view.
`filters`	object	No	Filter configuration that defines which resources this view displays.
`metadata`	object	No	Additional metadata associated with the view.
`user_id`	string (uuid)	Yes	ID of the user who created the view.
`created_at`	string (date-time)	Yes	Timestamp when the view was created.
`updated_at`	string (date-time)	Yes	Timestamp when the view was last updated.
`deleted_at`	string \| null (date-time)	No	Timestamp when the view was soft deleted. Null while the view remains active.

Example response

{
  "created_at": "0001-01-01T00:00:00Z",
  "deleted_at": null,
  "filters": {},
  "id": "00000000-0000-0000-0000-000000000000",
  "metadata": {},
  "name": "My Kubernetes View",
  "updated_at": "0001-01-01T00:00:00Z",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "visibility": "private"
}

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/content/views/{viewId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/content/views/{viewId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/content/views/{viewId}

Parameters

Path parameters

Name	Type	Required	Description
`viewId`	string (uuid)	Yes	View ID

Request body

application/json Required

Body for creating or updating a view

Payload for creating or updating a view.

Field	Type	Required	Description
`filters`	object	No	Filter configuration for this view.
`metadata`	object	No	Metadata associated with the view.
`name`	string	Yes	Display name of the view.
`visibility`	string	No	Visibility level of the view.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

A saved view with filters and metadata that defines a customized perspective of Meshery resources. Learn more at https://docs.meshery.io/concepts/logical/views

Field	Type	Required	Description
`id`	string (uuid)	Yes	Unique identifier for the view.
`name`	string	Yes	Display name of the view.
`visibility`	string	Yes	Visibility level of the view.
`filters`	object	No	Filter configuration that defines which resources this view displays.
`metadata`	object	No	Additional metadata associated with the view.
`user_id`	string (uuid)	Yes	ID of the user who created the view.
`created_at`	string (date-time)	Yes	Timestamp when the view was created.
`updated_at`	string (date-time)	Yes	Timestamp when the view was last updated.
`deleted_at`	string \| null (date-time)	No	Timestamp when the view was soft deleted. Null while the view remains active.

Example response

{
  "created_at": "0001-01-01T00:00:00Z",
  "deleted_at": null,
  "filters": {},
  "id": "00000000-0000-0000-0000-000000000000",
  "metadata": {},
  "name": "My Kubernetes View",
  "updated_at": "0001-01-01T00:00:00Z",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "visibility": "private"
}

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/content/views/{viewId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/content/views/{viewId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/content/views/{viewId}

Parameters

Path parameters

Name	Type	Required	Description
`viewId`	string (uuid)	Yes	View ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/entitlement/features

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/entitlement/features

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/entitlement/features

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`created_at`	string (date-time)	No	No description provided.
`id`	string (uuid)	Yes	A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
`name`	string	Yes	Enumeration of possible feature types
`plan`	object	No	No description provided.
`plan_id`	string (uuid)	Yes	A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
`quantity`	number	Yes	Quantity of the feature allowed, use 9999999999 for unlimited
`updated_at`	string (date-time)	No	No description provided.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/entitlement/plans

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/entitlement/plans

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/entitlement/plans

Parameters

Query parameters

Name	Type	Required	Description
`page`	string	No	Get responses by page
`pagesize`	string	No	Get responses by pagesize

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`cadence`	string	Yes	No description provided.
`currency`	string	Yes	No description provided.
`id`	string (uuid)	Yes	A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
`minimum_units`	integer	Yes	Minimum number of units required for the plan
`name`	string	Yes	Name of the plan
`price_per_unit`	number	Yes	Price per unit of the plan
`unit`	string	Yes	No description provided.

Authentication

Bearer JWT

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/entitlement/subscriptions

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/entitlement/subscriptions

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/entitlement/subscriptions

Parameters

Query parameters

Name	Type	Required	Description
`page`	string	No	Get responses by page
`pagesize`	string	No	Get responses by pagesize
`order`	string	No	Get ordered responses
`status`	array of string	No	Filter subscriptions by status

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`page`	integer	Yes	Current page number of the result set.
`page_size`	integer	Yes	Number of items per page.
`subscriptions`	array of object	Yes	Subscriptions returned in the current page of results.
`total_count`	integer	Yes	Total number of items available.

Authentication

Bearer JWT

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/entitlement/subscriptions/create

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/entitlement/subscriptions/create

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/entitlement/subscriptions/create

Request body

application/json Required

Field	Type	Required	Description
`couponId`	string	No	Coupon ID to apply
`email`	string (email)	No	Email of the customer
`orgId`	string (uuid)	No	Organization ID
`paymentProcessor`	string	No	Supported payment processors
`planId`	string	No	Price ID from the payment processor
`userCount`	integer	No	Number of users in the organization

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`clientSecret`	string	No	Client secret returned by the payment processor for the subscription checkout flow.
`subscriptionId`	string	No	ID of the associated subscription.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/entitlement/subscriptions/organizations/{organizationId}/features

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/entitlement/subscriptions/organizations/{organizationId}/features

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/entitlement/subscriptions/organizations/{organizationId}/features

Parameters

Path parameters

Name	Type	Required	Description
`organizationId`	string (uuid)	Yes	The ID of the organization

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`created_at`	string (date-time)	No	No description provided.
`id`	string (uuid)	Yes	A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
`name`	string	Yes	Enumeration of possible feature types
`plan`	object	No	No description provided.
`plan_id`	string (uuid)	Yes	A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
`quantity`	number	Yes	Quantity of the feature allowed, use 9999999999 for unlimited
`updated_at`	string (date-time)	No	No description provided.

Authentication

No authentication required

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/entitlement/subscriptions/webhooks

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/entitlement/subscriptions/webhooks

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/entitlement/subscriptions/webhooks

Request body

application/json Required

Payload for webhook events from payment processors

Schema: object

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Authentication

Bearer JWT

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/entitlement/subscriptions/{subscriptionId}/cancel

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/entitlement/subscriptions/{subscriptionId}/cancel

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/entitlement/subscriptions/{subscriptionId}/cancel

Parameters

Path parameters

Name	Type	Required	Description
`subscriptionId`	string	Yes	Subscription ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`page`	integer	Yes	Current page number of the result set.
`page_size`	integer	Yes	Number of items per page.
`subscriptions`	array of object	Yes	Subscriptions returned in the current page of results.
`total_count`	integer	Yes	Total number of items available.

Authentication

Bearer JWT

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/entitlement/subscriptions/{subscriptionId}/upgrade

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/entitlement/subscriptions/{subscriptionId}/upgrade

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/entitlement/subscriptions/{subscriptionId}/upgrade

Parameters

Path parameters

Name	Type	Required	Description
`subscriptionId`	string	Yes	Subscription ID

Request body

application/json Required

Field	Type	Required	Description
`newPlanId`	string (uuid)	No	New Plan id that is being changed to
`oldPlanId`	string (uuid)	No	Old Plan id that is being changed

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Subscription entity schema.

Field	Type	Required	Description
`billing_id`	string	Yes	Billing ID of the subscription. This is the ID of the subscription in the billing system. eg Stripe
`created_at`	string (date-time)	No	No description provided.
`deleted_at`	string (date-time)	No	No description provided.
`end_date`	string (date-time)	No	No description provided.
`id`	string (uuid)	Yes	A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
`org_id`	string (uuid)	Yes	A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
`plan`	object	No	Plan entity schema.
`plan_id`	string (uuid)	Yes	A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
`quantity`	integer	Yes	number of units subscribed (eg number of users)
`start_date`	string (date-time)	No	No description provided.
`status`	string	Yes	Possible statuses of a Stripe subscription.
`updated_at`	string (date-time)	No	No description provided.

Authentication

Bearer JWT

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/entitlement/subscriptions/{subscriptionId}/upgrade-preview

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/entitlement/subscriptions/{subscriptionId}/upgrade-preview

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/entitlement/subscriptions/{subscriptionId}/upgrade-preview

Parameters

Path parameters

Name	Type	Required	Description
`subscriptionId`	string	Yes	Subscription ID

Request body

application/json Required

Field	Type	Required	Description
`newPlanId`	string (uuid)	No	New Plan id that is being changed to
`oldPlanId`	string (uuid)	No	Old Plan id that is being changed

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/environments

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/environments

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/environments

Parameters

Query parameters

Name	Type	Required	Description
`search`	string	No	Get responses that match search param value
`order`	string	No	Get ordered responses
`page`	string	No	Get responses by page
`pagesize`	string	No	Get responses by pagesize
`orgId`	string	Yes	User’s organization ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`environments`	array of object	No	Environments associated with this resource.
`page`	integer	No	No description provided.
`page_size`	integer	No	No description provided.
`total_count`	integer	No	No description provided.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/environments

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/environments

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/environments

Request body

application/json Required

Body for creating environment

Field	Type	Required	Description
`description`	string	No	An environment is a collection of resources, such as connections & credentail. Provide a detailed description to clarify the purpose of this environment and the types of resources it encompasses. You can modify the description at any Time. Learn more about environments here.
`name`	string	Yes	An environment is a collection of resources. Provide a name that meaningfully represents these resources. You can change the name of the environment even after its creation.
`organization_id`	string (uuid)	Yes	Select an organization in which you want to create this new environment. Keep in mind that the organization cannot be changed after creation.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Environments allow you to logically group related Connections and their associated Credentials. Learn more at https://docs.meshery.io/concepts/logical/environments

Field	Type	Required	Description
`id`	string (uuid)	Yes	ID
`schemaVersion`	string	Yes	Specifies the version of the schema to which the environment conforms.
`name`	string	Yes	Environment name
`description`	string	Yes	Environment description
`organization_id`	string (uuid)	Yes	Environment organization ID
`owner`	string (uuid)	No	Environment owner
`created_at`	string (date-time)	No	Timestamp when the resource was created.
`metadata`	object	No	Additional metadata associated with the environment.
`updated_at`	string (date-time)	No	Timestamp when the resource was updated.
`deleted_at`	string \| null (date-time)	No	Timestamp when the environment was soft deleted. Null while the environment remains active.

Example response

{
  "created_at": "0001-01-01T00:00:00Z",
  "deleted_at": null,
  "description": "Connections and credentials for the production cluster.",
  "id": "00000000-0000-0000-0000-000000000000",
  "metadata": {},
  "name": "Production Environment",
  "organization_id": "00000000-0000-0000-0000-000000000000",
  "owner": "00000000-0000-0000-0000-000000000000",
  "schemaVersion": "environments.meshery.io/v1beta1",
  "updated_at": "0001-01-01T00:00:00Z"
}

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/environments/{environmentId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/environments/{environmentId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/environments/{environmentId}

Parameters

Path parameters

Name	Type	Required	Description
`environmentId`	string (uuid)	Yes	Environment ID

Query parameters

Name	Type	Required	Description
`orgId`	string	Yes	User’s organization ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`environments`	array of object	No	Environments associated with this resource.
`page`	integer	No	No description provided.
`page_size`	integer	No	No description provided.
`total_count`	integer	No	No description provided.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/environments/{environmentId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/environments/{environmentId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/environments/{environmentId}

Parameters

Path parameters

Name	Type	Required	Description
`environmentId`	string (uuid)	Yes	Environment ID

Request body

application/json Required

Body for creating environment

Field	Type	Required	Description
`description`	string	No	An environment is a collection of resources, such as connections & credentail. Provide a detailed description to clarify the purpose of this environment and the types of resources it encompasses. You can modify the description at any Time. Learn more about environments here.
`name`	string	Yes	An environment is a collection of resources. Provide a name that meaningfully represents these resources. You can change the name of the environment even after its creation.
`organization_id`	string (uuid)	Yes	Select an organization in which you want to create this new environment. Keep in mind that the organization cannot be changed after creation.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`environments`	array of object	No	Environments associated with this resource.
`page`	integer	No	No description provided.
`page_size`	integer	No	No description provided.
`total_count`	integer	No	No description provided.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/environments/{environmentId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/environments/{environmentId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/environments/{environmentId}

Parameters

Path parameters

Name	Type	Required	Description
`environmentId`	string (uuid)	Yes	Environment ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/environments/{environmentId}/connections

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/environments/{environmentId}/connections

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/environments/{environmentId}/connections

Parameters

Path parameters

Name	Type	Required	Description
`environmentId`	string (uuid)	Yes	Environment ID

Query parameters

Name	Type	Required	Description
`search`	string	No	Get responses that match search param value
`order`	string	No	Get ordered responses
`page`	string	No	Get responses by page
`pagesize`	string	No	Get responses by pagesize
`filter`	string	No	No description provided.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`connections`	array of object	No	The connections of the environmentconnectionspage.
`page`	integer	No	Current page number of the result set.
`page_size`	integer	No	Number of items per page.
`total_count`	integer	No	Total number of items available.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/environments/{environmentId}/connections/{connectionId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/environments/{environmentId}/connections/{connectionId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/environments/{environmentId}/connections/{connectionId}

Parameters

Path parameters

Name	Type	Required	Description
`environmentId`	string (uuid)	Yes	Environment ID
`connectionId`	string (uuid)	Yes	Connection ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/environments/{environmentId}/connections/{connectionId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/environments/{environmentId}/connections/{connectionId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/environments/{environmentId}/connections/{connectionId}

Parameters

Path parameters

Name	Type	Required	Description
`environmentId`	string (uuid)	Yes	Environment ID
`connectionId`	string (uuid)	Yes	Connection ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/events

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/events

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/events

Parameters

Query parameters

Name	Type	Required	Description
`cumulative`	boolean	No	No description provided.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`audit`	integer	No	The audit of the eventsaggregate.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/events/list

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/events/list

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/events/list

Parameters

Query parameters

Name	Type	Required	Description
`page`	string	No	Get responses by page
`pagesize`	string	No	Get responses by pagesize
`search`	string	No	Get responses that match search param value
`order`	string	No	Get ordered responses
`filter`	string	No	Get filtered reponses

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`data`	array of object	No	The data of the eventspage.
`page`	integer	No	No description provided.
`page_size`	integer	No	No description provided.
`total_count`	integer	No	No description provided.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/events/summary

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/events/summary

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/events/summary

Parameters

Query parameters

Name	Type	Required	Description
`page`	string	No	Get responses by page
`pagesize`	string	No	Get responses by pagesize
`search`	string	No	Get responses that match search param value
`order`	string	No	Get ordered responses
`filter`	string	No	Get filtered reponses

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`data`	array of object	No	The data of the eventsummarypage.
`page`	integer	No	Current page number of the result set.
`page_size`	integer	No	Number of items per page.
`total_count`	integer	No	Total number of items available.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/events/types

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/events/types

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/events/types

Parameters

Query parameters

Name	Type	Required	Description
`page`	string	No	Get responses by page
`pagesize`	string	No	Get responses by pagesize

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`action`	string	No	The action of the eventtype.
`category`	string	No	The category of the eventtype.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/badges

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/badges

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/badges

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`badges`	object	No	The badges of the badgespage.

Authentication

Bearer JWT

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/orgs

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/orgs

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/orgs

Parameters

Query parameters

Name	Type	Required	Description
`page`	string	No	Get responses by page
`pagesize`	string	No	Get responses by pagesize
`search`	string	No	Get responses that match search param value
`order`	string	No	Get ordered responses
`all`	boolean	No	Get all possible entries

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`organizations`	array of object	No	The organizations of the organizationspage.
`page`	integer	No	Current page number of the result set.
`page_size`	integer	No	Number of items per page.
`total_count`	integer	No	Total number of items available.

Authentication

Bearer JWT

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/orgs

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/orgs

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/orgs

Request body

application/json Required

Body for creating or updating an organization

Field	Type	Required	Description
`country`	string	No	No description provided.
`description`	string	No	No description provided.
`name`	string	No	No description provided.
`notifyOrgUpdate`	boolean	No	The notify org update of the organization.
`preferences`	object	No	No description provided.
`region`	string	No	No description provided.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Single-organization wrapper used by current meshery-cloud organization handlers.

Field	Type	Required	Description
`organizations`	array of object	No	The organizations of the organizationpage.
`page`	integer	No	Current page number of the result set.
`page_size`	integer	No	Number of items per page.
`total_count`	integer	No	Total number of items available.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/orgs/by-domain

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/orgs/by-domain

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/orgs/by-domain

Parameters

Query parameters

Name	Type	Required	Description
`domain`	string	Yes	No description provided.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`country`	string	Yes	The country of the organization.
`created_at`	string (date-time)	Yes	No description provided.
`deleted_at`	string (date-time)	No	No description provided.
`description`	string	Yes	Description of the organization.
`domain`	string \| null	No	The domain of the organization.
`id`	string (uuid)	Yes	A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
`metadata`	object	Yes	No description provided.
`name`	string	Yes	Name of the organization.
`owner`	string (uuid)	Yes	A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
`region`	string	Yes	The region of the organization.
`updated_at`	string (date-time)	Yes	No description provided.

Authentication

Bearer JWT

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/orgs/{orgId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/orgs/{orgId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/orgs/{orgId}

Parameters

Path parameters

Name	Type	Required	Description
`orgId`	string (uuid)	Yes	No description provided.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Single-organization wrapper used by current meshery-cloud organization handlers.

Field	Type	Required	Description
`organizations`	array of object	No	The organizations of the organizationpage.
`page`	integer	No	Current page number of the result set.
`page_size`	integer	No	Number of items per page.
`total_count`	integer	No	Total number of items available.

Authentication

Bearer JWT

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/orgs/{orgId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/orgs/{orgId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/orgs/{orgId}

Parameters

Path parameters

Name	Type	Required	Description
`orgId`	string (uuid)	Yes	No description provided.

Request body

application/json Required

Body for creating or updating an organization

Field	Type	Required	Description
`country`	string	No	No description provided.
`description`	string	No	No description provided.
`name`	string	No	No description provided.
`notifyOrgUpdate`	boolean	No	The notify org update of the organization.
`preferences`	object	No	No description provided.
`region`	string	No	No description provided.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Single-organization wrapper used by current meshery-cloud organization handlers.

Field	Type	Required	Description
`organizations`	array of object	No	The organizations of the organizationpage.
`page`	integer	No	Current page number of the result set.
`page_size`	integer	No	Number of items per page.
`total_count`	integer	No	Total number of items available.

Authentication

Bearer JWT

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/orgs/{orgId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/orgs/{orgId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/orgs/{orgId}

Parameters

Path parameters

Name	Type	Required	Description
`orgId`	string (uuid)	Yes	No description provided.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Authentication

Bearer JWT

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/orgs/{orgId}/preferences

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/orgs/{orgId}/preferences

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/orgs/{orgId}/preferences

Parameters

Path parameters

Name	Type	Required	Description
`orgId`	string (uuid)	Yes	No description provided.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`preferences`	object	Yes	No description provided.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/orgs/{orgId}/roles

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/orgs/{orgId}/roles

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/orgs/{orgId}/roles

Parameters

Path parameters

Name	Type	Required	Description
`orgId`	string (uuid)	Yes	Organization ID

Query parameters

Name	Type	Required	Description
`page`	string	No	Get responses by page
`pagesize`	string	No	Get responses by pagesize
`search`	string	No	Get responses that match search param value
`order`	string	No	Get ordered responses
`all`	boolean	No	Get all possible entries
`selector`	string	No	Role grouping selector such as provider, organization, or team.
`teamId`	string (uuid)	No	Team ID used when selector is team.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

A paginated list of roles.

Field	Type	Required	Description
`page`	integer	Yes	Current page number (zero-based).
`page_size`	integer	Yes	Number of roles per page.
`total_count`	integer	Yes	Total number of roles across all pages.
`roles`	array of object	Yes	The roles of the rolespage.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/orgs/{orgId}/roles

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/orgs/{orgId}/roles

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/orgs/{orgId}/roles

Parameters

Path parameters

Name	Type	Required	Description
`orgId`	string (uuid)	Yes	Organization ID

Request body

application/json Required

Role definition for Layer5 Cloud (Meshery).

Field	Type	Required	Description
`id`	string (uuid)	No	A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
`role_name`	string	Yes	Unique name of the role.
`description`	string	Yes	Human-readable description of the role.
`created_at`	string (date-time)	No	Timestamp when the resource was created.
`updated_at`	string (date-time)	No	Timestamp when the resource was updated.
`deleted_at`	string (date-time)	No	Timestamp when the role was soft-deleted.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Role definition for Layer5 Cloud (Meshery).

Field	Type	Required	Description
`id`	string (uuid)	No	A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
`role_name`	string	Yes	Unique name of the role.
`description`	string	Yes	Human-readable description of the role.
`created_at`	string (date-time)	No	Timestamp when the resource was created.
`updated_at`	string (date-time)	No	Timestamp when the resource was updated.
`deleted_at`	string (date-time)	No	Timestamp when the role was soft-deleted.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/orgs/{orgId}/roles

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/orgs/{orgId}/roles

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/orgs/{orgId}/roles

Parameters

Path parameters

Name	Type	Required	Description
`orgId`	string (uuid)	Yes	Organization ID

Request body

application/json Required

Field	Type	Required	Description
`id`	string (uuid)	No	A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
`user_id`	string (uuid)	No	A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
`username`	string	No	The username of the userroleupdaterequest.
`email`	string (email)	No	Email address.
`firstName`	string	No	The first name of the userroleupdaterequest.
`lastName`	string	No	The last name of the userroleupdaterequest.
`status`	string	No	Current status of the resource.
`roleNames`	array of string	No	The role names of the userroleupdaterequest.
`created_at`	string (date-time)	No	No description provided.
`updated_at`	string (date-time)	No	No description provided.
`deleted_at`	string (date-time)	No	SQL null Timestamp to handle null values of time.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/orgs/{orgId}/roles/{roleId}/keychains

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/orgs/{orgId}/roles/{roleId}/keychains

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/orgs/{orgId}/roles/{roleId}/keychains

Parameters

Path parameters

Name	Type	Required	Description
`orgId`	string (uuid)	Yes	Organization ID
`roleId`	string (uuid)	Yes	Role ID

Query parameters

Name	Type	Required	Description
`page`	string	No	Get responses by page
`pagesize`	string	No	Get responses by pagesize
`search`	string	No	Get responses that match search param value
`order`	string	No	Get ordered responses

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`page`	integer	Yes	No description provided.
`page_size`	integer	Yes	No description provided.
`total_count`	integer	Yes	No description provided.
`keychains`	array of object	Yes	The keychains of the keychainpage.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/orgs/{orgId}/roles/{roleId}/keychains/{keychainId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/orgs/{orgId}/roles/{roleId}/keychains/{keychainId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/orgs/{orgId}/roles/{roleId}/keychains/{keychainId}

Parameters

Path parameters

Name	Type	Required	Description
`orgId`	string (uuid)	Yes	Organization ID
`roleId`	string (uuid)	Yes	Role ID
`keychainId`	string (uuid)	Yes	Keychain ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/orgs/{orgId}/roles/{roleId}/keychains/{keychainId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/orgs/{orgId}/roles/{roleId}/keychains/{keychainId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/orgs/{orgId}/roles/{roleId}/keychains/{keychainId}

Parameters

Path parameters

Name	Type	Required	Description
`orgId`	string (uuid)	Yes	Organization ID
`roleId`	string (uuid)	Yes	Role ID
`keychainId`	string (uuid)	Yes	Keychain ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/orgs/{orgId}/teams

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/orgs/{orgId}/teams

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/orgs/{orgId}/teams

Parameters

Path parameters

Name	Type	Required	Description
`orgId`	string (uuid)	Yes	Organization ID

Query parameters

Name	Type	Required	Description
`search`	string	No	Get responses that match search param value
`order`	string	No	Get ordered responses
`page`	string	No	Get responses by page
`pagesize`	string	No	Get responses by pagesize

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Paginated list of teams

Field	Type	Required	Description
`page`	integer	No	No description provided.
`page_size`	integer	No	No description provided.
`teams`	array of object	No	The teams of the teampage.
`total_count`	integer	No	No description provided.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/orgs/{orgId}/teams

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/orgs/{orgId}/teams

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/orgs/{orgId}/teams

Parameters

Path parameters

Name	Type	Required	Description
`orgId`	string (uuid)	Yes	Organization ID

Request body

application/json Required

Body for creating a team

Payload for creating a new team

Field	Type	Required	Description
`description`	string	No	A detailed description of the team’s purpose and responsibilities.
`name`	string	Yes	Team name. Provide a meaningful name that represents this team.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

A Team is a group of one or more users. Teams are often used as a grouping mechanism for assigning permissions, whether in the context of an organization, a workspace, or some other domain within Meshery. Learn more at https://docs.meshery.io/concepts/logical/teams

Field	Type	Required	Description
`id`	string (uuid)	Yes	Team ID
`name`	string	Yes	Team name
`description`	string	No	Team description
`owner`	string (uuid)	No	User ID of the owner of the team
`metadata`	object	No	Additional metadata for the team
`created_at`	string (date-time)	No	No description provided.
`updated_at`	string (date-time)	No	No description provided.
`deleted_at`	string (date-time)	No	SQL null Timestamp to handle null values of time.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/orgs/{orgId}/teams/{teamId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/orgs/{orgId}/teams/{teamId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/orgs/{orgId}/teams/{teamId}

Parameters

Path parameters

Name	Type	Required	Description
`orgId`	string (uuid)	Yes	Organization ID
`teamId`	string (uuid)	Yes	Team ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

A Team is a group of one or more users. Teams are often used as a grouping mechanism for assigning permissions, whether in the context of an organization, a workspace, or some other domain within Meshery. Learn more at https://docs.meshery.io/concepts/logical/teams

Field	Type	Required	Description
`id`	string (uuid)	Yes	Team ID
`name`	string	Yes	Team name
`description`	string	No	Team description
`owner`	string (uuid)	No	User ID of the owner of the team
`metadata`	object	No	Additional metadata for the team
`created_at`	string (date-time)	No	No description provided.
`updated_at`	string (date-time)	No	No description provided.
`deleted_at`	string (date-time)	No	SQL null Timestamp to handle null values of time.

Authentication

Bearer JWT

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/orgs/{orgId}/teams/{teamId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/orgs/{orgId}/teams/{teamId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/orgs/{orgId}/teams/{teamId}

Parameters

Path parameters

Name	Type	Required	Description
`orgId`	string (uuid)	Yes	No description provided.
`teamId`	string (uuid)	Yes	No description provided.

Request body

application/json Optional

Optional action payload for POST on /api/identity/orgs/{orgId}/teams/{teamId}.

Field	Type	Required	Description
`action`	string	No	Internal action to perform on the team resource.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

object

Field	Type	Required	Description
`page`	integer	No	Current page number of the result set.
`page_size`	integer	No	Number of items per page.
`teamsOrganizationsMapping`	array of object	No	The teams organizations mapping of the teamsorganizationsmappingpage.
`total_count`	integer	No	Total number of items available.

object

Field	Type	Required	Description
`page`	integer	No	Current page number of the result set.
`page_size`	integer	No	Number of items per page.
`teams`	array of object	No	The teams of the teamspage.
`total_count`	integer	No	Total number of items available.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/orgs/{orgId}/teams/{teamId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/orgs/{orgId}/teams/{teamId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/orgs/{orgId}/teams/{teamId}

Parameters

Path parameters

Name	Type	Required	Description
`orgId`	string (uuid)	Yes	Organization ID
`teamId`	string (uuid)	Yes	Team ID

Request body

application/json Required

Body for updating a team

Payload for updating an existing team

Field	Type	Required	Description
`description`	string	No	Updated team description
`name`	string	No	Updated team name

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

A Team is a group of one or more users. Teams are often used as a grouping mechanism for assigning permissions, whether in the context of an organization, a workspace, or some other domain within Meshery. Learn more at https://docs.meshery.io/concepts/logical/teams

Field	Type	Required	Description
`id`	string (uuid)	Yes	Team ID
`name`	string	Yes	Team name
`description`	string	No	Team description
`owner`	string (uuid)	No	User ID of the owner of the team
`metadata`	object	No	Additional metadata for the team
`created_at`	string (date-time)	No	No description provided.
`updated_at`	string (date-time)	No	No description provided.
`deleted_at`	string (date-time)	No	SQL null Timestamp to handle null values of time.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/orgs/{orgId}/teams/{teamId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/orgs/{orgId}/teams/{teamId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/orgs/{orgId}/teams/{teamId}

Parameters

Path parameters

Name	Type	Required	Description
`orgId`	string (uuid)	Yes	Organization ID
`teamId`	string (uuid)	Yes	Team ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Authentication

Bearer JWT

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/orgs/{orgId}/teams/{teamId}/remove

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/orgs/{orgId}/teams/{teamId}/remove

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/orgs/{orgId}/teams/{teamId}/remove

Parameters

Path parameters

Name	Type	Required	Description
`orgId`	string (uuid)	Yes	No description provided.
`teamId`	string (uuid)	Yes	No description provided.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`page`	integer	No	Current page number of the result set.
`page_size`	integer	No	Number of items per page.
`teamsOrganizationsMapping`	array of object	No	The teams organizations mapping of the teamsorganizationsmappingpage.
`total_count`	integer	No	Total number of items available.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/orgs/{orgId}/teams/{teamId}/users

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/orgs/{orgId}/teams/{teamId}/users

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/orgs/{orgId}/teams/{teamId}/users

Parameters

Path parameters

Name	Type	Required	Description
`orgId`	string (uuid)	Yes	Organization ID
`teamId`	string (uuid)	Yes	Team ID

Query parameters

Name	Type	Required	Description
`search`	string	No	Get responses that match search param value
`order`	string	No	Get ordered responses
`page`	string	No	Get responses by page
`pagesize`	string	No	Get responses by pagesize

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`data`	array of object	No	The data of the teammemberspage.
`page`	integer	No	Current page number of the result set.
`page_size`	integer	No	Number of items per page.
`total_count`	integer	No	Total number of items available.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/orgs/{orgId}/teams/{teamId}/users/{userId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/orgs/{orgId}/teams/{teamId}/users/{userId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/orgs/{orgId}/teams/{teamId}/users/{userId}

Parameters

Path parameters

Name	Type	Required	Description
`orgId`	string (uuid)	Yes	Organization ID
`teamId`	string (uuid)	Yes	Team ID
`userId`	string	Yes	User ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Mapping between teams and users

Field	Type	Required	Description
`created_at`	string (date-time)	No	Timestamp when the resource was created.
`deleted_at`	string (date-time)	No	SQL null Timestamp to handle null values of time.
`id`	string (uuid)	No	No description provided.
`team_id`	string (uuid)	No	No description provided.
`updated_at`	string (date-time)	No	Timestamp when the resource was updated.
`user_id`	string	No	user’s email or username

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/orgs/{orgId}/teams/{teamId}/users/{userId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/orgs/{orgId}/teams/{teamId}/users/{userId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/orgs/{orgId}/teams/{teamId}/users/{userId}

Parameters

Path parameters

Name	Type	Required	Description
`orgId`	string (uuid)	Yes	Organization ID
`teamId`	string (uuid)	Yes	Team ID
`userId`	string	Yes	User ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/orgs/{orgId}/users

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/orgs/{orgId}/users

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/orgs/{orgId}/users

Parameters

Path parameters

Name	Type	Required	Description
`orgId`	string (uuid)	Yes	Organization ID

Query parameters

Name	Type	Required	Description
`page`	string	No	Get responses by page
`pagesize`	string	No	Get responses by pagesize
`search`	string	No	Get responses that match search param value
`order`	string	No	Get ordered responses
`filter`	string	No	Get filtered reponses
`teamId`	string (uuid)	No	Optional team filter when listing organization users

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Paginated list of users with organization and team role context

Field	Type	Required	Description
`data`	array of object	No	The data of the userspageforadmin.
`page`	integer	No	Current page number of the result set.
`page_size`	integer	No	Number of items per page.
`total_count`	integer	No	Total number of items available.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/orgs/{orgId}/users/invite

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/orgs/{orgId}/users/invite

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/orgs/{orgId}/users/invite

Parameters

Path parameters

Name	Type	Required	Description
`orgId`	string	Yes	The ID of the organization

Request body

application/json Required

Schema: object

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/orgs/{orgId}/users/keys

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/orgs/{orgId}/users/keys

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/orgs/{orgId}/users/keys

Parameters

Path parameters

Name	Type	Required	Description
`orgId`	string (uuid)	Yes	Organization ID

Query parameters

Name	Type	Required	Description
`page`	string	No	Get responses by page
`pagesize`	string	No	Get responses by pagesize

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`page`	integer	Yes	No description provided.
`page_size`	integer	Yes	No description provided.
`total_count`	integer	Yes	No description provided.
`keys`	array of object	Yes	The keys of the keypage.

Authentication

Bearer JWT

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/orgs/{orgId}/users/{userId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/orgs/{orgId}/users/{userId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/orgs/{orgId}/users/{userId}

Parameters

Path parameters

Name	Type	Required	Description
`orgId`	string (uuid)	Yes	No description provided.
`userId`	string	Yes	No description provided.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Authentication

Bearer JWT

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/orgs/{orgId}/users/{userId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/orgs/{orgId}/users/{userId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/orgs/{orgId}/users/{userId}

Parameters

Path parameters

Name	Type	Required	Description
`orgId`	string (uuid)	Yes	No description provided.
`userId`	string	Yes	No description provided.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/roles

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/roles

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/roles

Request body

application/json Required

Request body for assigning a role to a user.

Field	Type	Required	Description
`email`	string (email)	Yes	Email of the user to assign roles to.
`roleNames`	array of string	Yes	List of role names to assign.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/roles/{id}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/roles/{id}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/roles/{id}

Parameters

Path parameters

Name	Type	Required	Description
`id`	string (uuid)	Yes	Role ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/teams/{teamId}/users

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/teams/{teamId}/users

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/teams/{teamId}/users

Parameters

Path parameters

Name	Type	Required	Description
`teamId`	string (uuid)	Yes	Team ID

Query parameters

Name	Type	Required	Description
`search`	string	No	Get responses that match search param value
`order`	string	No	Get ordered responses
`page`	string	No	Get responses by page
`pagesize`	string	No	Get responses by pagesize

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Paginated list of team-user mappings

Field	Type	Required	Description
`page`	integer	No	No description provided.
`page_size`	integer	No	No description provided.
`teamsUsersMapping`	array of object	No	The teams users mapping of the teamsusersmappingpage.
`total_count`	integer	No	No description provided.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/tokens

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/tokens

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/tokens

Parameters

Query parameters

Name	Type	Required	Description
`isOAuth`	boolean	No	Whether to retrieve OAuth-backed sessions instead of API tokens.
`page`	string	No	Get responses by page
`pagesize`	string	No	Get responses by pagesize
`search`	string	No	Get responses that match search param value
`order`	string	No	Get ordered responses

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

A paginated list of tokens.

Field	Type	Required	Description
`tokens`	array of object	Yes	The tokens of the tokenpage.
`total_count`	integer	Yes	Total number of tokens across all pages.
`page`	integer	Yes	Current page number (zero-based).
`page_size`	integer	Yes	Number of tokens per page.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/tokens

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/tokens

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/tokens

Parameters

Query parameters

Name	Type	Required	Description
`name`	string	Yes	Name of the token.
`purpose`	string	No	Purpose for which the token is generated.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

A paginated list of tokens.

Field	Type	Required	Description
`tokens`	array of object	Yes	The tokens of the tokenpage.
`total_count`	integer	Yes	Total number of tokens across all pages.
`page`	integer	Yes	Current page number (zero-based).
`page_size`	integer	Yes	Number of tokens per page.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/tokens

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/tokens

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/tokens

Parameters

Query parameters

Name	Type	Required	Description
`tokenId`	string (uuid)	Yes	ID of the token.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

A paginated list of tokens.

Field	Type	Required	Description
`tokens`	array of object	Yes	The tokens of the tokenpage.
`total_count`	integer	Yes	Total number of tokens across all pages.
`page`	integer	Yes	Current page number (zero-based).
`page_size`	integer	Yes	Number of tokens per page.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/tokens/infinite

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/tokens/infinite

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/tokens/infinite

Parameters

Query parameters

Name	Type	Required	Description
`userId`	string (uuid)	Yes	UUID of the user.
`provider`	string	Yes	Remote provider.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

A paginated list of tokens.

Field	Type	Required	Description
`tokens`	array of object	Yes	The tokens of the tokenpage.
`total_count`	integer	Yes	Total number of tokens across all pages.
`page`	integer	Yes	Current page number (zero-based).
`page_size`	integer	Yes	Number of tokens per page.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/tokens/{id}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/tokens/{id}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/tokens/{id}

Parameters

Path parameters

Name	Type	Required	Description
`id`	string (uuid)	Yes	Token ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Represents a user-owned API token or OAuth session.

Field	Type	Required	Description
`id`	string (uuid)	Yes	Unique identifier for the token.
`user_id`	string (uuid)	Yes	UUID of the user who owns the token.
`provider`	string	Yes	Authentication provider associated with the token.
`access_token`	string	No	Access token value.
`refresh_token`	string	No	Refresh token value when applicable.
`name`	string	No	Human-readable token name.
`purpose`	string	No	Purpose for which the token was created.
`is_oauth`	boolean	No	Whether this entry represents an OAuth session.
`created_at`	string (date-time)	No	Timestamp when the resource was created.
`updated_at`	string (date-time)	No	Timestamp when the resource was updated.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/users/badges

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/users/badges

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/users/badges

Request body

application/json Required

Field	Type	Required	Description
`badges`	array of string	No	The badges of the badgeassignment.
`notify`	boolean	No	The notify of the badgeassignment.
`user_id`	string (uuid)	No	ID of the user who owns or created this resource.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/users/profile

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/users/profile

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/users/profile

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Represents a user in Layer5 Cloud (Meshery)

Field	Type	Required	Description
`accepted_terms_at`	string (date-time)	No	Timestamp when user accepted terms and conditions
`avatar_url`	string (uri)	No	URL to user’s avatar image
`bio`	string	No	User’s biography or description
`country`	object	No	User’s country information stored as JSONB
`created_at`	string (date-time)	Yes	Timestamp when the user record was created
`deleted_at`	string \| null (date-time)	Yes	Timestamp when the user record was soft-deleted (null if not deleted)
`email`	string (email)	Yes	User’s email address
`first_login_time`	string (date-time)	No	Timestamp of user’s first login
`first_name`	string	Yes	User’s first name
`id`	string (uuid)	Yes	Unique identifier for the user
`last_login_time`	string (date-time)	Yes	Timestamp of user’s most recent login
`last_name`	string	Yes	User’s last name
`organizations`	object	No	Organizations the user belongs to with role information
`preferences`	object	No	User preferences stored as JSONB
`provider`	string	Yes	Authentication provider (e.g., Layer5 Cloud, Twitter, Facebook, Github)
`region`	object	No	User’s region information stored as JSONB
`role_names`	array of string	No	List of global roles assigned to the user
`socials`	array of object	No	Various online profiles associated with the user account
`status`	string	Yes	User account status
`teams`	object	No	Teams the user belongs to with role information
`updated_at`	string (date-time)	Yes	Timestamp when the user record was last updated
`user_id`	string	Yes	User identifier (username or external ID)

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/users/profile/{id}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/users/profile/{id}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/users/profile/{id}

Parameters

Path parameters

Name	Type	Required	Description
`id`	string (uuid)	Yes	User ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Represents a user in Layer5 Cloud (Meshery)

Field	Type	Required	Description
`accepted_terms_at`	string (date-time)	No	Timestamp when user accepted terms and conditions
`avatar_url`	string (uri)	No	URL to user’s avatar image
`bio`	string	No	User’s biography or description
`country`	object	No	User’s country information stored as JSONB
`created_at`	string (date-time)	Yes	Timestamp when the user record was created
`deleted_at`	string \| null (date-time)	Yes	Timestamp when the user record was soft-deleted (null if not deleted)
`email`	string (email)	Yes	User’s email address
`first_login_time`	string (date-time)	No	Timestamp of user’s first login
`first_name`	string	Yes	User’s first name
`id`	string (uuid)	Yes	Unique identifier for the user
`last_login_time`	string (date-time)	Yes	Timestamp of user’s most recent login
`last_name`	string	Yes	User’s last name
`organizations`	object	No	Organizations the user belongs to with role information
`preferences`	object	No	User preferences stored as JSONB
`provider`	string	Yes	Authentication provider (e.g., Layer5 Cloud, Twitter, Facebook, Github)
`region`	object	No	User’s region information stored as JSONB
`role_names`	array of string	No	List of global roles assigned to the user
`socials`	array of object	No	Various online profiles associated with the user account
`status`	string	Yes	User account status
`teams`	object	No	Teams the user belongs to with role information
`updated_at`	string (date-time)	Yes	Timestamp when the user record was last updated
`user_id`	string	Yes	User identifier (username or external ID)

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/users/request

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/users/request

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/users/request

Parameters

Query parameters

Name	Type	Required	Description
`page`	string	No	Get responses by page
`pagesize`	string	No	Get responses by pagesize
`search`	string	No	Get responses that match search param value
`order`	string	No	Get ordered responses
`filter`	string	No	Get filtered reponses

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`data`	array of object	No	The data of the signuprequestspage.
`page`	integer	No	Current page number of the result set.
`page_size`	integer	No	Number of items per page.
`total_count`	integer	No	Total number of items available.

Authentication

No authentication required

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/users/request

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/users/request

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/users/request

Request body

application/json Required

Schema: object

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/users/request/approve

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/users/request/approve

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/users/request/approve

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/users/request/deny

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/users/request/deny

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/users/request/deny

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/identity/users/request/notification

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/identity/users/request/notification

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/identity/users/request/notification

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/integrations/connections

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/integrations/connections

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/integrations/connections

Parameters

Query parameters

Name	Type	Required	Description
`page`	integer	No	Page number
`pagesize`	integer	No	Number of items per page
`search`	string	No	Search term
`order`	string	No	Sort order
`filter`	string	No	Filter connections (general filter string)
`kind`	array of string	No	Filter by connection kind (e.g., kubernetes, prometheus, grafana)
`status`	array of string	No	Filter by connection status
`type`	array of string	No	Filter by connection type
`name`	string	No	Filter by connection name (partial match supported)

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Represents a page of connections with meta information about connections count

Field	Type	Required	Description
`connections`	array of object	Yes	List of connections on this page
`total_count`	integer	Yes	Total number of connections on all pages
`page`	integer	Yes	Current page number
`page_size`	integer	Yes	Number of elements per page
`statusSummary`	object	No	Aggregate count of connections grouped by status

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/integrations/connections

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/integrations/connections

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/integrations/connections

Request body

application/json Required

Payload for creating or updating a connection

Field	Type	Required	Description
`credentialId`	string (uuid)	No	Associated credential ID
`credentialSecret`	object	No	Credential secret data
`id`	string (uuid)	No	Connection ID
`kind`	string	Yes	Connection kind
`metadata`	object	No	Connection metadata
`name`	string	Yes	Connection name
`status`	string	Yes	Connection status
`subType`	string	Yes	Connection sub-type
`type`	string	Yes	Connection type

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Meshery Connections are managed and unmanaged resources that either through discovery or manual entry are tracked by Meshery. Learn more at https://docs.meshery.io/concepts/logical/connections

Field	Type	Required	Description
`id`	string (uuid)	Yes	Connection ID
`name`	string	Yes	Connection Name
`credential_id`	string (uuid)	No	Associated Credential ID
`type`	string	Yes	Connection Type (platform, telemetry, collaboration)
`sub_type`	string	Yes	Connection Subtype (cloud, identity, metrics, chat, git, orchestration)
`kind`	string	Yes	Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github)
`metadata`	object	No	Additional connection metadata
`status`	string	Yes	Connection Status
`user_id`	string (uuid)	No	User ID who owns this connection
`created_at`	string (date-time)	No	No description provided.
`updated_at`	string (date-time)	No	No description provided.
`deleted_at`	string (date-time)	No	SQL null Timestamp to handle null values of time.
`environments`	array of object	No	Associated environments for this connection
`schemaVersion`	string	Yes	Specifies the version of the schema used for the definition.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/integrations/connections/kubernetes/{connectionId}/context

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/integrations/connections/kubernetes/{connectionId}/context

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/integrations/connections/kubernetes/{connectionId}/context

Parameters

Path parameters

Name	Type	Required	Description
`connectionId`	string (uuid)	Yes	Connection ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/integrations/connections/meshery/{mesheryServerId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/integrations/connections/meshery/{mesheryServerId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/integrations/connections/meshery/{mesheryServerId}

Parameters

Path parameters

Name	Type	Required	Description
`mesheryServerId`	string (uuid)	Yes	Meshery server ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/integrations/connections/{connectionId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/integrations/connections/{connectionId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/integrations/connections/{connectionId}

Parameters

Path parameters

Name	Type	Required	Description
`connectionId`	string (uuid)	Yes	Connection ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Meshery Connections are managed and unmanaged resources that either through discovery or manual entry are tracked by Meshery. Learn more at https://docs.meshery.io/concepts/logical/connections

Field	Type	Required	Description
`id`	string (uuid)	Yes	Connection ID
`name`	string	Yes	Connection Name
`credential_id`	string (uuid)	No	Associated Credential ID
`type`	string	Yes	Connection Type (platform, telemetry, collaboration)
`sub_type`	string	Yes	Connection Subtype (cloud, identity, metrics, chat, git, orchestration)
`kind`	string	Yes	Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github)
`metadata`	object	No	Additional connection metadata
`status`	string	Yes	Connection Status
`user_id`	string (uuid)	No	User ID who owns this connection
`created_at`	string (date-time)	No	No description provided.
`updated_at`	string (date-time)	No	No description provided.
`deleted_at`	string (date-time)	No	SQL null Timestamp to handle null values of time.
`environments`	array of object	No	Associated environments for this connection
`schemaVersion`	string	Yes	Specifies the version of the schema used for the definition.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/integrations/connections/{connectionId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/integrations/connections/{connectionId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/integrations/connections/{connectionId}

Parameters

Path parameters

Name	Type	Required	Description
`connectionId`	string (uuid)	Yes	Connection ID

Request body

application/json Required

Payload for creating or updating a connection

Field	Type	Required	Description
`credentialId`	string (uuid)	No	Associated credential ID
`credentialSecret`	object	No	Credential secret data
`id`	string (uuid)	No	Connection ID
`kind`	string	Yes	Connection kind
`metadata`	object	No	Connection metadata
`name`	string	Yes	Connection name
`status`	string	Yes	Connection status
`subType`	string	Yes	Connection sub-type
`type`	string	Yes	Connection type

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Meshery Connections are managed and unmanaged resources that either through discovery or manual entry are tracked by Meshery. Learn more at https://docs.meshery.io/concepts/logical/connections

Field	Type	Required	Description
`id`	string (uuid)	Yes	Connection ID
`name`	string	Yes	Connection Name
`credential_id`	string (uuid)	No	Associated Credential ID
`type`	string	Yes	Connection Type (platform, telemetry, collaboration)
`sub_type`	string	Yes	Connection Subtype (cloud, identity, metrics, chat, git, orchestration)
`kind`	string	Yes	Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github)
`metadata`	object	No	Additional connection metadata
`status`	string	Yes	Connection Status
`user_id`	string (uuid)	No	User ID who owns this connection
`created_at`	string (date-time)	No	No description provided.
`updated_at`	string (date-time)	No	No description provided.
`deleted_at`	string (date-time)	No	SQL null Timestamp to handle null values of time.
`environments`	array of object	No	Associated environments for this connection
`schemaVersion`	string	Yes	Specifies the version of the schema used for the definition.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/integrations/connections/{connectionId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/integrations/connections/{connectionId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/integrations/connections/{connectionId}

Parameters

Path parameters

Name	Type	Required	Description
`connectionId`	string (uuid)	Yes	Connection ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/integrations/credentials

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/integrations/credentials

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/integrations/credentials

Parameters

Query parameters

Name	Type	Required	Description
`page`	string	No	Get responses by page
`pagesize`	string	No	Get responses by pagesize
`search`	string	No	Get responses that match search param value
`order`	string	No	Get ordered responses

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

A paginated list of credentials.

Field	Type	Required	Description
`credentials`	array of object	Yes	The credentials of the credentialpage.
`total_count`	integer	Yes	Total number of credentials across all pages.
`page`	integer	Yes	Current page number (zero-based).
`page_size`	integer	Yes	Number of credentials per page.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/integrations/credentials

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/integrations/credentials

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/integrations/credentials

Request body

application/json Required

Meshery Credentials store sensitive information such as API keys, tokens, and passwords used by connections to external systems.

Field	Type	Required	Description
`id`	string (uuid)	No	Unique identifier for the credential.
`name`	string	Yes	Human-readable name for the credential.
`user_id`	string (uuid)	No	UUID of the user who owns this credential.
`type`	string	Yes	Credential type (e.g. token, basic, AWS).
`secret`	object	No	Key-value pairs containing the sensitive credential data.
`created_at`	string (date-time)	No	Timestamp when the resource was created.
`updated_at`	string (date-time)	No	Timestamp when the resource was updated.
`deleted_at`	string (date-time)	No	Timestamp when the credential was soft-deleted.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Meshery Credentials store sensitive information such as API keys, tokens, and passwords used by connections to external systems.

Field	Type	Required	Description
`id`	string (uuid)	No	Unique identifier for the credential.
`name`	string	Yes	Human-readable name for the credential.
`user_id`	string (uuid)	No	UUID of the user who owns this credential.
`type`	string	Yes	Credential type (e.g. token, basic, AWS).
`secret`	object	No	Key-value pairs containing the sensitive credential data.
`created_at`	string (date-time)	No	Timestamp when the resource was created.
`updated_at`	string (date-time)	No	Timestamp when the resource was updated.
`deleted_at`	string (date-time)	No	Timestamp when the credential was soft-deleted.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/integrations/credentials

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/integrations/credentials

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/integrations/credentials

Request body

application/json Required

Meshery Credentials store sensitive information such as API keys, tokens, and passwords used by connections to external systems.

Field	Type	Required	Description
`id`	string (uuid)	No	Unique identifier for the credential.
`name`	string	Yes	Human-readable name for the credential.
`user_id`	string (uuid)	No	UUID of the user who owns this credential.
`type`	string	Yes	Credential type (e.g. token, basic, AWS).
`secret`	object	No	Key-value pairs containing the sensitive credential data.
`created_at`	string (date-time)	No	Timestamp when the resource was created.
`updated_at`	string (date-time)	No	Timestamp when the resource was updated.
`deleted_at`	string (date-time)	No	Timestamp when the credential was soft-deleted.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Meshery Credentials store sensitive information such as API keys, tokens, and passwords used by connections to external systems.

Field	Type	Required	Description
`id`	string (uuid)	No	Unique identifier for the credential.
`name`	string	Yes	Human-readable name for the credential.
`user_id`	string (uuid)	No	UUID of the user who owns this credential.
`type`	string	Yes	Credential type (e.g. token, basic, AWS).
`secret`	object	No	Key-value pairs containing the sensitive credential data.
`created_at`	string (date-time)	No	Timestamp when the resource was created.
`updated_at`	string (date-time)	No	Timestamp when the resource was updated.
`deleted_at`	string (date-time)	No	Timestamp when the credential was soft-deleted.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/integrations/credentials

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/integrations/credentials

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/integrations/credentials

Parameters

Query parameters

Name	Type	Required	Description
`credentialId`	string (uuid)	Yes	Credential ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/integrations/credentials/{id}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/integrations/credentials/{id}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/integrations/credentials/{id}

Parameters

Path parameters

Name	Type	Required	Description
`id`	string (uuid)	Yes	Credential ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Meshery Credentials store sensitive information such as API keys, tokens, and passwords used by connections to external systems.

Field	Type	Required	Description
`id`	string (uuid)	No	Unique identifier for the credential.
`name`	string	Yes	Human-readable name for the credential.
`user_id`	string (uuid)	No	UUID of the user who owns this credential.
`type`	string	Yes	Credential type (e.g. token, basic, AWS).
`secret`	object	No	Key-value pairs containing the sensitive credential data.
`created_at`	string (date-time)	No	Timestamp when the resource was created.
`updated_at`	string (date-time)	No	Timestamp when the resource was updated.
`deleted_at`	string (date-time)	No	Timestamp when the credential was soft-deleted.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/integrations/meshmodels/models

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/integrations/meshmodels/models

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/integrations/meshmodels/models

Parameters

Query parameters

Name	Type	Required	Description
`page`	string	No	No description provided.
`pagesize`	string	No	No description provided.
`search`	string	No	No description provided.
`order`	string	No	No description provided.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`models`	array of object	No	The models of the meshmodelmodelspage.
`page`	integer	No	Current page number of the result set.
`page_size`	integer	No	Number of items per page.
`total_count`	integer	No	Total number of items available.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/meshmodels/register

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/meshmodels/register

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/meshmodels/register

Request body

multipart/form-data Required

Field	Type	Required	Description
`importBody`	one of File Import, URL Import, CSV Import, Model Create	Yes	No description provided.
`register`	boolean	Yes	The register of the importrequest.
`uploadType`	string	Yes	Choose the method you prefer to upload your model file. Select ‘File Import’ or ‘CSV Import’ if you have the file on your local system or ‘URL Import’ if you have the file hosted online.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`message`	string	No	No description provided.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/organizations/badges

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/organizations/badges

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/organizations/badges

Request body

application/json Required

Payload for creating or updating a badge.

Field	Type	Required	Description
`description`	string	Yes	A description of the milestone achieved, often including criteria for receiving this recognition.
`id`	string (uuid)	No	Existing badge ID for updates; omit on create.
`image_url`	string (uri)	Yes	URL to the badge image
`label`	string	Yes	unique identifier for the badge ( auto generated )
`name`	string	Yes	Concise descriptor for the badge or certificate.
`org_id`	string (uuid)	Yes	The ID of the organization in which this badge is available.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`created_at`	string (date-time)	Yes	Timestamp when the resource was created.
`deleted_at`	string (date-time)	Yes	Timestamp when the resource was deleted, if applicable
`description`	string	Yes	A description of the milestone achieved, often including criteria for receiving this recognition.
`id`	string (uuid)	Yes	A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
`image_url`	string (uri)	Yes	URL to the badge image
`label`	string	Yes	unique identifier for the badge ( auto generated )
`name`	string	Yes	Concise descriptor for the badge or certificate.
`org_id`	string (uuid)	Yes	The ID of the organization in which this badge is available .
`updated_at`	string (date-time)	Yes	Timestamp when the resource was updated.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/organizations/badges/{id}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/organizations/badges/{id}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/organizations/badges/{id}

Parameters

Path parameters

Name	Type	Required	Description
`id`	string (uuid)	Yes	Unique identifier

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`created_at`	string (date-time)	Yes	Timestamp when the resource was created.
`deleted_at`	string (date-time)	Yes	Timestamp when the resource was deleted, if applicable
`description`	string	Yes	A description of the milestone achieved, often including criteria for receiving this recognition.
`id`	string (uuid)	Yes	A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
`image_url`	string (uri)	Yes	URL to the badge image
`label`	string	Yes	unique identifier for the badge ( auto generated )
`name`	string	Yes	Concise descriptor for the badge or certificate.
`org_id`	string (uuid)	Yes	The ID of the organization in which this badge is available .
`updated_at`	string (date-time)	Yes	Timestamp when the resource was updated.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/organizations/badges/{id}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/organizations/badges/{id}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/organizations/badges/{id}

Parameters

Path parameters

Name	Type	Required	Description
`id`	string (uuid)	Yes	Unique identifier

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/organizations/invitations

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/organizations/invitations

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/organizations/invitations

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`data`	array of object	Yes	List of invitations
`total`	integer	Yes	Total number of invitations available

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/organizations/invitations

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/organizations/invitations

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/organizations/invitations

Request body

application/json Required

Payload for creating or updating an invitation.

Field	Type	Required	Description
`description`	string	Yes	Description of the invitation.
`emails`	array of string	Yes	The emails of the invitation.
`expires_at`	string (date-time)	No	Timestamp when the invitation expires, if applicable.
`id`	string (uuid)	No	Existing invitation ID for updates; omit on create.
`is_default`	boolean	No	Indicates whether the invitation is a default invitation (open invite).
`name`	string	Yes	Name of the invitation.
`org_id`	string (uuid)	Yes	ID of the organization to which the user is invited.
`owner_id`	string (uuid)	No	ID of the user who created the invitation.
`quota`	integer	No	Quota for the invitation.
`roles`	array of string	Yes	The roles of the invitation.
`status`	string	Yes	Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later.
`teams`	array of string	Yes	The teams of the invitation.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Invitation entity schema.

Field	Type	Required	Description
`accepted_by`	array of string	Yes	List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet
`created_at`	string (date-time)	Yes	Timestamp when the invitation was created
`deleted_at`	string (date-time)	Yes	Timestamp when the invitation was deleted, if applicable
`description`	string	Yes	Description of the invitation, which can be used to provide additional information about the invitation, null or empty string means the invitation does not have a description
`emails`	array of string	Yes	The emails of the invitation.
`expires_at`	string (date-time)	No	Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire
`id`	string (uuid)	Yes	Unique identifier for the invitation , is also used as the invitation code
`is_default`	boolean	No	Indicates whether the invitation is a default invitation (open invite), which can be used to assign users when signing up from fqdn or custom domain, a organization can only have one default invitation
`name`	string	Yes	Name of the invitation, which can be used to identify the invitation, required and cant be empty string,
`org_id`	string (uuid)	Yes	ID of the organization to which the user is invited
`owner_id`	string (uuid)	Yes	ID of the user who created the invitation, this is used to track who created the invitation and can be used for auditing purposes
`quota`	integer	No	Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota
`roles`	array of string	Yes	The roles of the invitation.
`status`	string	Yes	Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later.
`teams`	array of string	Yes	The teams of the invitation.
`updated_at`	string (date-time)	Yes	Timestamp when the invitation was last updated

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/organizations/invitations/{invitationId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/organizations/invitations/{invitationId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/organizations/invitations/{invitationId}

Parameters

Path parameters

Name	Type	Required	Description
`invitationId`	string	Yes	The ID of the invitation

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Invitation entity schema.

Field	Type	Required	Description
`accepted_by`	array of string	Yes	List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet
`created_at`	string (date-time)	Yes	Timestamp when the invitation was created
`deleted_at`	string (date-time)	Yes	Timestamp when the invitation was deleted, if applicable
`description`	string	Yes	Description of the invitation, which can be used to provide additional information about the invitation, null or empty string means the invitation does not have a description
`emails`	array of string	Yes	The emails of the invitation.
`expires_at`	string (date-time)	No	Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire
`id`	string (uuid)	Yes	Unique identifier for the invitation , is also used as the invitation code
`is_default`	boolean	No	Indicates whether the invitation is a default invitation (open invite), which can be used to assign users when signing up from fqdn or custom domain, a organization can only have one default invitation
`name`	string	Yes	Name of the invitation, which can be used to identify the invitation, required and cant be empty string,
`org_id`	string (uuid)	Yes	ID of the organization to which the user is invited
`owner_id`	string (uuid)	Yes	ID of the user who created the invitation, this is used to track who created the invitation and can be used for auditing purposes
`quota`	integer	No	Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota
`roles`	array of string	Yes	The roles of the invitation.
`status`	string	Yes	Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later.
`teams`	array of string	Yes	The teams of the invitation.
`updated_at`	string (date-time)	Yes	Timestamp when the invitation was last updated

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/organizations/invitations/{invitationId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/organizations/invitations/{invitationId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/organizations/invitations/{invitationId}

Parameters

Path parameters

Name	Type	Required	Description
`invitationId`	string	Yes	The ID of the invitation

Request body

application/json Required

Payload for creating or updating an invitation.

Field	Type	Required	Description
`description`	string	Yes	Description of the invitation.
`emails`	array of string	Yes	The emails of the invitation.
`expires_at`	string (date-time)	No	Timestamp when the invitation expires, if applicable.
`id`	string (uuid)	No	Existing invitation ID for updates; omit on create.
`is_default`	boolean	No	Indicates whether the invitation is a default invitation (open invite).
`name`	string	Yes	Name of the invitation.
`org_id`	string (uuid)	Yes	ID of the organization to which the user is invited.
`owner_id`	string (uuid)	No	ID of the user who created the invitation.
`quota`	integer	No	Quota for the invitation.
`roles`	array of string	Yes	The roles of the invitation.
`status`	string	Yes	Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later.
`teams`	array of string	Yes	The teams of the invitation.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Invitation entity schema.

Field	Type	Required	Description
`accepted_by`	array of string	Yes	List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet
`created_at`	string (date-time)	Yes	Timestamp when the invitation was created
`deleted_at`	string (date-time)	Yes	Timestamp when the invitation was deleted, if applicable
`description`	string	Yes	Description of the invitation, which can be used to provide additional information about the invitation, null or empty string means the invitation does not have a description
`emails`	array of string	Yes	The emails of the invitation.
`expires_at`	string (date-time)	No	Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire
`id`	string (uuid)	Yes	Unique identifier for the invitation , is also used as the invitation code
`is_default`	boolean	No	Indicates whether the invitation is a default invitation (open invite), which can be used to assign users when signing up from fqdn or custom domain, a organization can only have one default invitation
`name`	string	Yes	Name of the invitation, which can be used to identify the invitation, required and cant be empty string,
`org_id`	string (uuid)	Yes	ID of the organization to which the user is invited
`owner_id`	string (uuid)	Yes	ID of the user who created the invitation, this is used to track who created the invitation and can be used for auditing purposes
`quota`	integer	No	Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota
`roles`	array of string	Yes	The roles of the invitation.
`status`	string	Yes	Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later.
`teams`	array of string	Yes	The teams of the invitation.
`updated_at`	string (date-time)	Yes	Timestamp when the invitation was last updated

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/organizations/invitations/{invitationId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/organizations/invitations/{invitationId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/organizations/invitations/{invitationId}

Parameters

Path parameters

Name	Type	Required	Description
`invitationId`	string	Yes	The ID of the invitation

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/organizations/invitations/{invitationId}/accept

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/organizations/invitations/{invitationId}/accept

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/organizations/invitations/{invitationId}/accept

Parameters

Path parameters

Name	Type	Required	Description
`invitationId`	string	Yes	The ID of the invitation

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Invitation entity schema.

Field	Type	Required	Description
`accepted_by`	array of string	Yes	List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet
`created_at`	string (date-time)	Yes	Timestamp when the invitation was created
`deleted_at`	string (date-time)	Yes	Timestamp when the invitation was deleted, if applicable
`description`	string	Yes	Description of the invitation, which can be used to provide additional information about the invitation, null or empty string means the invitation does not have a description
`emails`	array of string	Yes	The emails of the invitation.
`expires_at`	string (date-time)	No	Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire
`id`	string (uuid)	Yes	Unique identifier for the invitation , is also used as the invitation code
`is_default`	boolean	No	Indicates whether the invitation is a default invitation (open invite), which can be used to assign users when signing up from fqdn or custom domain, a organization can only have one default invitation
`name`	string	Yes	Name of the invitation, which can be used to identify the invitation, required and cant be empty string,
`org_id`	string (uuid)	Yes	ID of the organization to which the user is invited
`owner_id`	string (uuid)	Yes	ID of the user who created the invitation, this is used to track who created the invitation and can be used for auditing purposes
`quota`	integer	No	Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota
`roles`	array of string	Yes	The roles of the invitation.
`status`	string	Yes	Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later.
`teams`	array of string	Yes	The teams of the invitation.
`updated_at`	string (date-time)	Yes	Timestamp when the invitation was last updated

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/pattern/import

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/pattern/import

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/pattern/import

Request body

multipart/form-data Required

Choose the method you prefer to upload your design file. Select ‘File Upload’ if you have the file on your local system, or ‘URL Import’ if you have the file hosted online.

Field	Type	Required	Description
`file`	string (file)	No	Supported formats: Kubernetes Manifests, Helm Charts, Docker Compose, and Meshery Designs. See Import Designs Documentation for details
`fileName`	string	No	The name of the pattern file being imported.
`name`	string	No	Provide a name for your design file. This name will help you identify the file more easily. You can also change the name of your design after importing it.
`url`	string (uri)	No	Provide the URL of the file you want to import. This should be a direct URL to a single file, for example: https://raw.github.com/your-design-file.yaml. Also, ensure that design is in a supported format: Kubernetes Manifest, Helm Chart, Docker Compose, or Meshery Design. See Import Designs Documentation for details

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`message`	string	No	No description provided.

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/resource/{resourceType}/share/{resourceId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/resource/{resourceType}/share/{resourceId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/resource/{resourceType}/share/{resourceId}

Path parameters

Name	Type	Required	Description
`resourceType`	string	Yes	No description provided.
`resourceId`	string	Yes	No description provided.

application/json Required

Schema: object

Returned data

Status codes, content types, and response schemas returned by this endpoint.

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/resource/{resourceType}/share/{resourceId}/{actorType}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/resource/{resourceType}/share/{resourceId}/{actorType}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/resource/{resourceType}/share/{resourceId}/{actorType}

Path parameters

Name	Type	Required	Description
`resourceType`	string	Yes	No description provided.
`resourceId`	string	Yes	No description provided.
`actorType`	string	Yes	No description provided.

Returned data

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`users`	array of object	No	The users of the resourceaccessactorsresponse.

Authentication

No authentication required

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/users

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/users

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/users

Parameters

Query parameters

Name	Type	Required	Description
`page`	string	No	Get responses by page
`pagesize`	string	No	Get responses by pagesize
`search`	string	No	Get responses that match search param value
`order`	string	No	Get ordered responses
`filter`	string	No	Get filtered reponses

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Paginated list of public user records

Field	Type	Required	Description
`data`	array of object	No	The data of the userspagefornonadmin.
`page`	integer	No	Current page number of the result set.
`page_size`	integer	No	Number of items per page.
`total_count`	integer	No	Total number of items available.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/workspaces

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/workspaces

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/workspaces

Parameters

Query parameters

Name	Type	Required	Description
`search`	string	No	Get responses that match search param value
`order`	string	No	Get ordered responses
`page`	string	No	Get responses by page
`pagesize`	string	No	Get responses by pagesize
`filter`	string	No	JSON-encoded filter string used for assignment and soft-delete filters.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Paginated list of workspaces.

Field	Type	Required	Description
`page`	integer	No	No description provided.
`page_size`	integer	No	No description provided.
`total_count`	integer	No	No description provided.
`workspaces`	array of object	No	List of workspaces with resolved owner details.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/workspaces

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/workspaces

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/workspaces

Request body

application/json Required

Body for creating a workspace

Payload for creating a workspace.

Field	Type	Required	Description
`description`	string	No	Description of the workspace.
`metadata`	object	No	Metadata associated with the workspace.
`name`	string	Yes	Name of the workspace.
`organization_id`	string (uuid)	Yes	Organization ID.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

A workspace is a logical grouping of resources within an organization. Workspaces provide a way to organize environments, designs, teams, and views. Learn more at https://docs.meshery.io/concepts/logical/workspaces

Field	Type	Required	Description
`created_at`	string (date-time)	Yes	Timestamp when the resource was created.
`deleted_at`	string (date-time)	No	Timestamp when the resource was deleted.
`description`	string	No	Description of the workspace.
`id`	string (uuid)	Yes	No description provided.
`metadata`	object	No	Metadata associated with the workspace.
`name`	string	Yes	Name of the workspace.
`organization_id`	string (uuid)	Yes	Organization to which this workspace belongs.
`owner`	string (uuid)	No	User ID of the workspace owner.
`updated_at`	string (date-time)	Yes	Timestamp when the resource was updated.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/workspaces/{workspaceId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/workspaces/{workspaceId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/workspaces/{workspaceId}

Parameters

Path parameters

Name	Type	Required	Description
`workspaceId`	string (uuid)	Yes	Workspace ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

A workspace is a logical grouping of resources within an organization. Workspaces provide a way to organize environments, designs, teams, and views. Learn more at https://docs.meshery.io/concepts/logical/workspaces

Field	Type	Required	Description
`created_at`	string (date-time)	Yes	Timestamp when the resource was created.
`deleted_at`	string (date-time)	No	Timestamp when the resource was deleted.
`description`	string	No	Description of the workspace.
`id`	string (uuid)	Yes	No description provided.
`metadata`	object	No	Metadata associated with the workspace.
`name`	string	Yes	Name of the workspace.
`organization_id`	string (uuid)	Yes	Organization to which this workspace belongs.
`owner`	string (uuid)	No	User ID of the workspace owner.
`updated_at`	string (date-time)	Yes	Timestamp when the resource was updated.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/workspaces/{workspaceId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/workspaces/{workspaceId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/workspaces/{workspaceId}

Parameters

Path parameters

Name	Type	Required	Description
`workspaceId`	string (uuid)	Yes	Workspace ID

Request body

application/json Required

Body for updating a workspace

Payload for updating a workspace.

Field	Type	Required	Description
`description`	string	No	Description of the workspace.
`metadata`	object	No	Metadata associated with the workspace.
`name`	string	No	Name of the workspace.
`organization_id`	string (uuid)	Yes	Organization ID.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

A workspace is a logical grouping of resources within an organization. Workspaces provide a way to organize environments, designs, teams, and views. Learn more at https://docs.meshery.io/concepts/logical/workspaces

Field	Type	Required	Description
`created_at`	string (date-time)	Yes	Timestamp when the resource was created.
`deleted_at`	string (date-time)	No	Timestamp when the resource was deleted.
`description`	string	No	Description of the workspace.
`id`	string (uuid)	Yes	No description provided.
`metadata`	object	No	Metadata associated with the workspace.
`name`	string	Yes	Name of the workspace.
`organization_id`	string (uuid)	Yes	Organization to which this workspace belongs.
`owner`	string (uuid)	No	User ID of the workspace owner.
`updated_at`	string (date-time)	Yes	Timestamp when the resource was updated.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/workspaces/{workspaceId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/workspaces/{workspaceId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/workspaces/{workspaceId}

Parameters

Path parameters

Name	Type	Required	Description
`workspaceId`	string (uuid)	Yes	Workspace ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/workspaces/{workspaceId}/designs

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/workspaces/{workspaceId}/designs

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/workspaces/{workspaceId}/designs

Parameters

Path parameters

Name	Type	Required	Description
`workspaceId`	string (uuid)	Yes	Workspace ID

Query parameters

Name	Type	Required	Description
`search`	string	No	Get responses that match search param value
`order`	string	No	Get ordered responses
`page`	string	No	Get responses by page
`pagesize`	string	No	Get responses by pagesize
`filter`	string	No	JSON-encoded filter string used for assignment and soft-delete filters.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Paginated list of designs.

Field	Type	Required	Description
`designs`	array of object	No	Designs in this page.
`page`	integer	No	No description provided.
`page_size`	integer	No	No description provided.
`total_count`	integer	No	No description provided.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/workspaces/{workspaceId}/designs/{designId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/workspaces/{workspaceId}/designs/{designId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/workspaces/{workspaceId}/designs/{designId}

Parameters

Path parameters

Name	Type	Required	Description
`workspaceId`	string (uuid)	Yes	Workspace ID
`designId`	string (uuid)	Yes	Design ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Paginated list of workspace-design mappings.

Field	Type	Required	Description
`page`	integer	No	No description provided.
`page_size`	integer	No	No description provided.
`total_count`	integer	No	No description provided.
`workspacesDesignsMapping`	array of object	No	Workspace-design mapping entries.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/workspaces/{workspaceId}/designs/{designId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/workspaces/{workspaceId}/designs/{designId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/workspaces/{workspaceId}/designs/{designId}

Parameters

Path parameters

Name	Type	Required	Description
`workspaceId`	string (uuid)	Yes	Workspace ID
`designId`	string (uuid)	Yes	Design ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/workspaces/{workspaceId}/environments

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/workspaces/{workspaceId}/environments

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/workspaces/{workspaceId}/environments

Parameters

Path parameters

Name	Type	Required	Description
`workspaceId`	string (uuid)	Yes	Workspace ID

Query parameters

Name	Type	Required	Description
`search`	string	No	Get responses that match search param value
`order`	string	No	Get ordered responses
`page`	string	No	Get responses by page
`pagesize`	string	No	Get responses by pagesize
`filter`	string	No	JSON-encoded filter string used for assignment and soft-delete filters.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`environments`	array of object	No	Environments associated with this resource.
`page`	integer	No	No description provided.
`page_size`	integer	No	No description provided.
`total_count`	integer	No	No description provided.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/workspaces/{workspaceId}/environments/{environmentId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/workspaces/{workspaceId}/environments/{environmentId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/workspaces/{workspaceId}/environments/{environmentId}

Parameters

Path parameters

Name	Type	Required	Description
`workspaceId`	string (uuid)	Yes	Workspace ID
`environmentId`	string (uuid)	Yes	Environment ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Paginated list of workspace-environment mappings.

Field	Type	Required	Description
`page`	integer	No	No description provided.
`page_size`	integer	No	No description provided.
`total_count`	integer	No	No description provided.
`workspacesEnvironmentsMapping`	array of object	No	Workspace-environment mapping entries.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/workspaces/{workspaceId}/environments/{environmentId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/workspaces/{workspaceId}/environments/{environmentId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/workspaces/{workspaceId}/environments/{environmentId}

Parameters

Path parameters

Name	Type	Required	Description
`workspaceId`	string (uuid)	Yes	Workspace ID
`environmentId`	string (uuid)	Yes	Environment ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Authentication

Bearer JWT

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/workspaces/{workspaceId}/events

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/workspaces/{workspaceId}/events

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/workspaces/{workspaceId}/events

Parameters

Path parameters

Name	Type	Required	Description
`workspaceId`	string (uuid)	Yes	Workspace ID

Query parameters

Name	Type	Required	Description
`page`	string	No	Get responses by page
`pagesize`	string	No	Get responses by pagesize
`search`	string	No	Get responses that match search param value
`order`	string	No	Get ordered responses

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`data`	array of object	No	The data of the eventspage.
`page`	integer	No	No description provided.
`page_size`	integer	No	No description provided.
`total_count`	integer	No	No description provided.

Field	Type	Required	Description
`error`	string	No	The error of the errorresponse.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/workspaces/{workspaceId}/teams

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/workspaces/{workspaceId}/teams

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/workspaces/{workspaceId}/teams

Parameters

Path parameters

Name	Type	Required	Description
`workspaceId`	string (uuid)	Yes	Workspace ID

Query parameters

Name	Type	Required	Description
`search`	string	No	Get responses that match search param value
`order`	string	No	Get ordered responses
`page`	string	No	Get responses by page
`pagesize`	string	No	Get responses by pagesize
`filter`	string	No	JSON-encoded filter string used for assignment and soft-delete filters.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Paginated list of teams

Field	Type	Required	Description
`page`	integer	No	No description provided.
`page_size`	integer	No	No description provided.
`teams`	array of object	No	The teams of the teampage.
`total_count`	integer	No	No description provided.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/workspaces/{workspaceId}/teams/{teamId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/workspaces/{workspaceId}/teams/{teamId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/workspaces/{workspaceId}/teams/{teamId}

Parameters

Path parameters

Name	Type	Required	Description
`workspaceId`	string (uuid)	Yes	Workspace ID
`teamId`	string (uuid)	Yes	Team ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Paginated list of workspace-team mappings.

Field	Type	Required	Description
`page`	integer	No	No description provided.
`page_size`	integer	No	No description provided.
`total_count`	integer	No	No description provided.
`workspacesTeamsMapping`	array of object	No	Workspace-team mapping entries.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/workspaces/{workspaceId}/teams/{teamId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/workspaces/{workspaceId}/teams/{teamId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/workspaces/{workspaceId}/teams/{teamId}

Parameters

Path parameters

Name	Type	Required	Description
`workspaceId`	string (uuid)	Yes	Workspace ID
`teamId`	string (uuid)	Yes	Team ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/workspaces/{workspaceId}/views

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/workspaces/{workspaceId}/views

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/workspaces/{workspaceId}/views

Parameters

Path parameters

Name	Type	Required	Description
`workspaceId`	string (uuid)	Yes	Workspace ID

Query parameters

Name	Type	Required	Description
`search`	string	No	Get responses that match search param value
`order`	string	No	Get ordered responses
`page`	string	No	Get responses by page
`pagesize`	string	No	Get responses by pagesize
`filter`	string	No	JSON-encoded filter string used for assignment and soft-delete filters.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Paginated list of views with location enrichment.

Field	Type	Required	Description
`page`	integer	No	No description provided.
`page_size`	integer	No	No description provided.
`total_count`	integer	No	No description provided.
`views`	array of object	No	Views in this page, enriched with workspace and organization context.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/workspaces/{workspaceId}/views/{viewId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/workspaces/{workspaceId}/views/{viewId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/workspaces/{workspaceId}/views/{viewId}

Parameters

Path parameters

Name	Type	Required	Description
`workspaceId`	string (uuid)	Yes	Workspace ID
`viewId`	string (uuid)	Yes	View ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Paginated list of workspace-view mappings.

Field	Type	Required	Description
`page`	integer	No	No description provided.
`page_size`	integer	No	No description provided.
`total_count`	integer	No	No description provided.
`workspacesViewsMapping`	array of object	No	Workspace-view mapping entries.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/api/workspaces/{workspaceId}/views/{viewId}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/api/workspaces/{workspaceId}/views/{viewId}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/api/workspaces/{workspaceId}/views/{viewId}

Parameters

Path parameters

Name	Type	Required	Description
`workspaceId`	string (uuid)	Yes	Workspace ID
`viewId`	string (uuid)	Yes	View ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/events

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/events

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/events

Request body

application/json Required

Schema: object

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/events/delete

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/events/delete

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/events/delete

Request body

application/json Required

Field	Type	Required	Description
`ids`	array of string (uuid)	Yes	The ids of the bulkdeleterequest.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`deleted`	array of string (uuid)	No	No description provided.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/events/status

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/events/status

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/events/status

Request body

application/json Required

Field	Type	Required	Description
`ids`	array of string (uuid)	Yes	The ids of the bulkupdatestatusrequest.
`status`	string	Yes	Current status of the resource.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`updated`	array of string (uuid)	No	No description provided.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/events/{id}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/events/{id}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/events/{id}

Parameters

Path parameters

Name	Type	Required	Description
`id`	string (uuid)	Yes	ID of the event to delete

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/events/{id}/status

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/events/{id}/status

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/events/{id}/status

Parameters

Path parameters

Name	Type	Required	Description
`id`	string (uuid)	Yes	ID of the event

Request body

application/json Required

Field	Type	Required	Description
`status`	string	Yes	Current status of the resource.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

Field	Type	Required	Description
`event_id`	string (uuid)	No	No description provided.
`message`	string	No	No description provided.
`status`	string	No	No description provided.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/user/schedules

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/user/schedules

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/user/schedules

Parameters

Query parameters

Name	Type	Required	Description
`page`	string	No	Get responses by page
`pagesize`	string	No	Get responses by pagesize
`search`	string	No	Get responses that match search param value
`order`	string	No	Get ordered responses

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

A paginated list of schedules.

Field	Type	Required	Description
`page`	integer	Yes	Current page number (zero-based).
`page_size`	integer	Yes	Number of schedules per page.
`total_count`	integer	Yes	Total number of schedules across all pages.
`schedules`	array of object	Yes	The schedules of the schedulepage.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/user/schedules

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/user/schedules

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/user/schedules

Request body

application/json Required

A schedule defines a recurring cron-based trigger for performance tests or other automated tasks.

Field	Type	Required	Description
`id`	string (uuid)	No	Unique identifier for the schedule.
`name`	string	Yes	Human-readable name for the schedule.
`user_id`	string (uuid)	Yes	UUID of the user who owns this schedule.
`cron_expression`	string	Yes	Cron expression defining the schedule’s recurrence (e.g. “0 0 * * *” for daily at midnight).
`created_at`	string (date-time)	No	Timestamp when the resource was created.
`updated_at`	string (date-time)	No	Timestamp when the resource was updated.

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

A schedule defines a recurring cron-based trigger for performance tests or other automated tasks.

Field	Type	Required	Description
`id`	string (uuid)	No	Unique identifier for the schedule.
`name`	string	Yes	Human-readable name for the schedule.
`user_id`	string (uuid)	Yes	UUID of the user who owns this schedule.
`cron_expression`	string	Yes	Cron expression defining the schedule’s recurrence (e.g. “0 0 * * *” for daily at midnight).
`created_at`	string (date-time)	No	Timestamp when the resource was created.
`updated_at`	string (date-time)	No	Timestamp when the resource was updated.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/user/schedules/{id}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/user/schedules/{id}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/user/schedules/{id}

Parameters

Path parameters

Name	Type	Required	Description
`id`	string (uuid)	Yes	Schedule ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.

A schedule defines a recurring cron-based trigger for performance tests or other automated tasks.

Field	Type	Required	Description
`id`	string (uuid)	No	Unique identifier for the schedule.
`name`	string	Yes	Human-readable name for the schedule.
`user_id`	string (uuid)	Yes	UUID of the user who owns this schedule.
`cron_expression`	string	Yes	Cron expression defining the schedule’s recurrence (e.g. “0 0 * * *” for daily at midnight).
`created_at`	string (date-time)	No	Timestamp when the resource was created.
`updated_at`	string (date-time)	No	Timestamp when the resource was updated.

Try this endpoint

Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.

Meshery Cloud production server URL

https://cloud.meshery.io/user/schedules/{id}

Meshery Cloud staging server URL

https://staging-cloud.meshery.io/user/schedules/{id}

Meshery Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/user/schedules/{id}

Parameters

Path parameters

Name	Type	Required	Description
`id`	string (uuid)	Yes	Schedule ID

Returned data

Responses

Status codes, content types, and response schemas returned by this endpoint.