REST API Reference

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

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

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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 (uuid)	Yes	User’s organization ID

Returned data

Responses

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

Paginated list of environments.

Field	Type	Required	Description
`environments`	array of object	No	Environments associated with this resource.
`page`	integer	No	Zero-based page index returned in this response.
`pageSize`	integer	No	Maximum number of items returned on each page.
`totalCount`	integer	No	Total number of items across all pages.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

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

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/api/environments

Request body

application/json Required

Body for creating environment

Payload for creating or updating an environment.

Field	Type	Required	Description
`description`	string	No	An environment is a collection of resources, such as connections & credentials. 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.
`organizationId`	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
`organizationId`	string (uuid)	Yes	Environment organization ID
`owner`	string (uuid)	No	Environment owner
`createdAt`	string (date-time)	No	Timestamp when the environment was created.
`metadata`	object	No	Additional metadata associated with the environment.
`updatedAt`	string (date-time)	No	Timestamp when the environment was last updated.
`deletedAt`	string \| null (date-time)	No	Timestamp when the environment was soft deleted. Null while the environment remains active.

Example response

{
  "createdAt": "0001-01-01T00:00:00Z",
  "deletedAt": null,
  "description": "Connections and credentials for the production cluster.",
  "id": "00000000-0000-0000-0000-000000000000",
  "metadata": {},
  "name": "Production Environment",
  "organizationId": "00000000-0000-0000-0000-000000000000",
  "owner": "00000000-0000-0000-0000-000000000000",
  "schemaVersion": "environments.meshery.io/v1beta3",
  "updatedAt": "0001-01-01T00:00:00Z"
}

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

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

Meshery Server URL (controlled via PORT environment variable)

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

Parameters

Path parameters

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

Query parameters

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

Returned data

Responses

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

Paginated list of environments.

Field	Type	Required	Description
`environments`	array of object	No	Environments associated with this resource.
`page`	integer	No	Zero-based page index returned in this response.
`pageSize`	integer	No	Maximum number of items returned on each page.
`totalCount`	integer	No	Total number of items across all pages.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

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

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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

Payload for creating or updating an environment.

Field	Type	Required	Description
`description`	string	No	An environment is a collection of resources, such as connections & credentials. 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.
`organizationId`	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.

Paginated list of environments.

Field	Type	Required	Description
`environments`	array of object	No	Environments associated with this resource.
`page`	integer	No	Zero-based page index returned in this response.
`pageSize`	integer	No	Maximum number of items returned on each page.
`totalCount`	integer	No	Total number of items across all pages.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

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

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

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

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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	JSON-encoded filter string used to scope the connection listing.

Returned data

Responses

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

Paginated list of connections associated with an environment.

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

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

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

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

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

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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.

Schema: string

Authentication

Bearer JWT

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

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

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/api/identity/orgs

Parameters

Query parameters

Name	Type	Required	Description
`page`	integer	No	Zero-based index of the result page to return.
`pageSize`	integer	No	Maximum number of items returned on each page.
`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.

Paginated list of organizations.

Field	Type	Required	Description
`organizations`	array of object	No	Organizations in this page.
`page`	integer	No	Zero-based page index returned in this response.
`pageSize`	integer	No	Maximum number of items returned on each page.
`totalCount`	integer	No	Total number of items across all pages.

Schema: string

Authentication

Bearer JWT

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

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

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/api/identity/orgs

Request body

application/json Required

Body for creating or updating an organization

Payload for creating or updating an organization. Contains only client-settable fields.

Field	Type	Required	Description
`country`	string	No	Country of the organization.
`description`	string	No	Description of the organization.
`name`	string	No	Name of the organization.
`notifyOrgUpdate`	boolean	No	Indicates whether organization members should be notified of this update.
`preferences`	object	No	Organization-level user experience preferences.
`region`	string	No	Region of the organization.

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	Organizations returned in this single-item page wrapper.
`page`	integer	No	Zero-based page index returned in this response.
`pageSize`	integer	No	Maximum number of items returned on each page.
`totalCount`	integer	No	Total number of items across all pages.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

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

Meshery Server URL (controlled via PORT environment variable)

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

Parameters

Query parameters

Name	Type	Required	Description
`domain`	string	Yes	Domain name of the organization to look up.

Returned data

Responses

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

An organization in Meshery Cloud. Organizations are the top-level tenancy boundary and own teams, workspaces, environments, designs, and other resources. Learn more at https://docs.meshery.io/concepts/logical/organizations

Field	Type	Required	Description
`country`	string	Yes	Country of the organization.
`createdAt`	string (date-time)	Yes	Timestamp when the organization was created.
`deletedAt`	string (date-time)	No	Timestamp when the organization was soft-deleted. Null while the organization is active.
`description`	string	Yes	Description of the organization.
`domain`	string \| null	No	Domain of the organization.
`id`	string (uuid)	Yes	Organization ID.
`metadata`	object	Yes	Free-form metadata associated with the organization, including preferences.
`name`	string	Yes	Name of the organization.
`owner`	string (uuid)	Yes	Owner user ID of the organization.
`region`	string	Yes	Region of the organization.
`updatedAt`	string (date-time)	Yes	Timestamp when the organization was last updated.

Schema: string

Authentication

Bearer JWT

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

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

Meshery Server URL (controlled via PORT environment variable)

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

Parameters

Path parameters

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

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	Organizations returned in this single-item page wrapper.
`page`	integer	No	Zero-based page index returned in this response.
`pageSize`	integer	No	Maximum number of items returned on each page.
`totalCount`	integer	No	Total number of items across all pages.

Schema: string

Authentication

Bearer JWT

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

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

Meshery Server URL (controlled via PORT environment variable)

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

Parameters

Path parameters

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

Request body

application/json Required

Body for creating or updating an organization

Payload for creating or updating an organization. Contains only client-settable fields.

Field	Type	Required	Description
`country`	string	No	Country of the organization.
`description`	string	No	Description of the organization.
`name`	string	No	Name of the organization.
`notifyOrgUpdate`	boolean	No	Indicates whether organization members should be notified of this update.
`preferences`	object	No	Organization-level user experience preferences.
`region`	string	No	Region of the organization.

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	Organizations returned in this single-item page wrapper.
`page`	integer	No	Zero-based page index returned in this response.
`pageSize`	integer	No	Maximum number of items returned on each page.
`totalCount`	integer	No	Total number of items across all pages.

Schema: string

Authentication

Bearer JWT

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

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

Meshery Server URL (controlled via PORT environment variable)

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

Parameters

Path parameters

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

Returned data

Responses

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

Schema: string

Authentication

Bearer JWT

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

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

Meshery Server URL (controlled via PORT environment variable)

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

Parameters

Path parameters

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

Returned data

Responses

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

Free-form metadata associated with an organization, including preferences.

Field	Type	Required	Description
`preferences`	object	Yes	Organization-level user experience preferences.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

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

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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	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 teampage.
`total_count`	integer	No	Total number of items available.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

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

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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
`createdAt`	string (date-time)	Yes	Timestamp when the team was created.
`updatedAt`	string (date-time)	Yes	Timestamp when the team was last updated.
`deletedAt`	string (date-time)	No	Timestamp when the team was soft-deleted, if applicable.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

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

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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
`createdAt`	string (date-time)	Yes	Timestamp when the team was created.
`updatedAt`	string (date-time)	Yes	Timestamp when the team was last updated.
`deletedAt`	string (date-time)	No	Timestamp when the team was soft-deleted, if applicable.

Schema: string

Authentication

Bearer JWT

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

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

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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 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.

Schema: one of object

object

Paginated list of team-organization mappings.

Field	Type	Required	Description
`page`	integer	No	Zero-based page index returned in this response.
`pageSize`	integer	No	Maximum number of items returned on each page.
`teamsOrganizationsMapping`	array of object	No	Team-organization mapping entries.
`totalCount`	integer	No	Total number of items across all pages.

object

Paginated list of teams.

Field	Type	Required	Description
`page`	integer	No	Zero-based page index returned in this response.
`pageSize`	integer	No	Maximum number of items returned on each page.
`teams`	array of object	No	Teams in this page.
`totalCount`	integer	No	Total number of items across all pages.

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

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

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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
`createdAt`	string (date-time)	Yes	Timestamp when the team was created.
`updatedAt`	string (date-time)	Yes	Timestamp when the team was last updated.
`deletedAt`	string (date-time)	No	Timestamp when the team was soft-deleted, if applicable.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

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

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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.

Schema: string

Authentication

Bearer JWT

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

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

Meshery Server URL (controlled via PORT environment variable)

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

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.

Paginated list of team-organization mappings.

Field	Type	Required	Description
`page`	integer	No	Zero-based page index returned in this response.
`pageSize`	integer	No	Maximum number of items returned on each page.
`teamsOrganizationsMapping`	array of object	No	Team-organization mapping entries.
`totalCount`	integer	No	Total number of items across all pages.

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

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

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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.

Paginated list of team members.

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.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

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

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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.

Join row between users and teams. The schema name is UsersTeamsMapping (rather than TeamsUsersMapping) so that pop’s tableize default produces the live DB table name users_teams_mappings, eliminating the need for an explicit TableName() helper on the generated Go struct.

Field	Type	Required	Description
`createdAt`	string (date-time)	No	Timestamp when the mapping was created.
`deletedAt`	string (date-time)	No	Timestamp when the mapping was soft-deleted, if applicable.
`id`	string (uuid)	No	No description provided.
`roleId`	string (uuid)	No	Optional role assigned to this team membership. Nullable because a membership may exist without an explicit role (e.g., team-admin assignments are stamped on insert; non-owner adds may leave `role_id` null until a role is assigned). References `roles.id`.
`teamId`	string (uuid)	No	Team ID
`updatedAt`	string (date-time)	No	Timestamp when the mapping was last updated.
`userId`	string (uuid)	No	User ID

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

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

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

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

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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 page size
`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.
`pageSize`	integer	No	Number of items per page.
`totalCount`	integer	No	Total number of items available.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/identity/orgs/{orgId}/users/keys

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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.

A paginated list of authorization keys.

Field	Type	Required	Description
`page`	integer	Yes	Zero-based page index returned in this response.
`pageSize`	integer	Yes	Maximum number of items returned on each page.
`totalCount`	integer	Yes	Total number of items across all pages.
`keys`	array of object	Yes	Keys returned on the current page.

Schema: string

Authentication

Bearer JWT

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/identity/orgs/{orgId}/users/{userId}

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/api/identity/orgs/{orgId}/users/{userId}

Parameters

Path parameters

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

Returned data

Responses

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

Schema: object

Schema: string

Authentication

Bearer JWT

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/identity/orgs/{orgId}/users/{userId}

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/api/identity/orgs/{orgId}/users/{userId}

Parameters

Path parameters

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

Returned data

Responses

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

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/identity/teams/{teamId}/users

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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 user-team mappings

Field	Type	Required	Description
`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.
`usersTeamsMapping`	array of object	No	The user-team mappings on the current page.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/identity/users/profile

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/api/identity/users/profile

Returned data

Responses

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

Represents a user

Field	Type	Required	Description
`acceptedTermsAt`	string (date-time)	No	Timestamp when user accepted terms and conditions
`avatarUrl`	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
`createdAt`	string (date-time)	Yes	Timestamp when the user record was created
`deletedAt`	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
`firstLoginTime`	string (date-time)	No	Timestamp of user’s first login
`firstName`	string	Yes	User’s first name
`id`	string (uuid)	Yes	Unique identifier for the user
`lastLoginTime`	string (date-time)	Yes	Timestamp of user’s most recent login
`lastName`	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., Google, Github)
`region`	object	No	User’s region information stored as JSONB
`roleNames`	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
`updatedAt`	string (date-time)	Yes	Timestamp when the user record was last updated
`userId`	string	Yes	User identifier (username or external ID)

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/identity/users/profile/{id}

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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

Field	Type	Required	Description
`acceptedTermsAt`	string (date-time)	No	Timestamp when user accepted terms and conditions
`avatarUrl`	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
`createdAt`	string (date-time)	Yes	Timestamp when the user record was created
`deletedAt`	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
`firstLoginTime`	string (date-time)	No	Timestamp of user’s first login
`firstName`	string	Yes	User’s first name
`id`	string (uuid)	Yes	Unique identifier for the user
`lastLoginTime`	string (date-time)	Yes	Timestamp of user’s most recent login
`lastName`	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., Google, Github)
`region`	object	No	User’s region information stored as JSONB
`roleNames`	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
`updatedAt`	string (date-time)	Yes	Timestamp when the user record was last updated
`userId`	string	Yes	User identifier (username or external ID)

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/integrations/connections

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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
`orgId`	string (uuid)	No	Organization ID to scope the request.
`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
`totalCount`	integer	Yes	Total number of connections on all pages
`page`	integer	Yes	Current page number
`pageSize`	integer	Yes	Number of elements per page
`statusSummary`	object	No	Aggregate count of connections grouped by status

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/integrations/connections

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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
`description`	string	No	Human-readable description of the connection and its purpose.
`url`	string (uri)	No	URL of the remote resource this connection points to (e.g. the Helm repository URL, the Kubernetes API server endpoint, the Grafana instance URL).
`credentialId`	string (uuid)	No	Associated Credential ID
`type`	string	Yes	Connection Type (platform, telemetry, collaboration)
`subType`	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
`userId`	string (uuid)	No	User ID who owns this connection
`createdAt`	string (date-time)	No	Timestamp when the connection was created.
`updatedAt`	string (date-time)	No	Timestamp when the connection was last updated.
`deletedAt`	string (date-time)	No	Timestamp when the connection was soft-deleted, if applicable.
`environments`	array of object	No	Associated environments for this connection
`schemaVersion`	string	Yes	Specifies the version of the schema used for the definition.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/integrations/connections/kubernetes/{connectionId}/context

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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.

Schema: object

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/integrations/connections/meshery/{mesheryServerId}

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/integrations/connections/{connectionId}

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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
`description`	string	No	Human-readable description of the connection and its purpose.
`url`	string (uri)	No	URL of the remote resource this connection points to (e.g. the Helm repository URL, the Kubernetes API server endpoint, the Grafana instance URL).
`credentialId`	string (uuid)	No	Associated Credential ID
`type`	string	Yes	Connection Type (platform, telemetry, collaboration)
`subType`	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
`userId`	string (uuid)	No	User ID who owns this connection
`createdAt`	string (date-time)	No	Timestamp when the connection was created.
`updatedAt`	string (date-time)	No	Timestamp when the connection was last updated.
`deletedAt`	string (date-time)	No	Timestamp when the connection was soft-deleted, if applicable.
`environments`	array of object	No	Associated environments for this connection
`schemaVersion`	string	Yes	Specifies the version of the schema used for the definition.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/integrations/connections/{connectionId}

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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
`description`	string	No	Human-readable description of the connection and its purpose.
`url`	string (uri)	No	URL of the remote resource this connection points to (e.g. the Helm repository URL, the Kubernetes API server endpoint, the Grafana instance URL).
`credentialId`	string (uuid)	No	Associated Credential ID
`type`	string	Yes	Connection Type (platform, telemetry, collaboration)
`subType`	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
`userId`	string (uuid)	No	User ID who owns this connection
`createdAt`	string (date-time)	No	Timestamp when the connection was created.
`updatedAt`	string (date-time)	No	Timestamp when the connection was last updated.
`deletedAt`	string (date-time)	No	Timestamp when the connection was soft-deleted, if applicable.
`environments`	array of object	No	Associated environments for this connection
`schemaVersion`	string	Yes	Specifies the version of the schema used for the definition.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/integrations/connections/{connectionId}

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/integrations/credentials

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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 returned on the current page.
`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.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/integrations/credentials

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/api/integrations/credentials

Request body

application/json Required

Payload for creating or updating a credential.

Field	Type	Required	Description
`id`	string (uuid)	No	Existing credential ID for updates; omit on create.
`name`	string	Yes	Human-readable name for the credential.
`userId`	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.

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)	Yes	Unique identifier for the credential.
`name`	string	Yes	Human-readable name for the credential.
`userId`	string (uuid)	Yes	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.
`createdAt`	string (date-time)	Yes	Timestamp when the credential was created.
`updatedAt`	string (date-time)	Yes	Timestamp when the credential was last updated.
`deletedAt`	string (date-time)	No	Timestamp when the credential was soft-deleted.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/integrations/credentials

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/api/integrations/credentials

Request body

application/json Required

Payload for creating or updating a credential.

Field	Type	Required	Description
`id`	string (uuid)	No	Existing credential ID for updates; omit on create.
`name`	string	Yes	Human-readable name for the credential.
`userId`	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.

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)	Yes	Unique identifier for the credential.
`name`	string	Yes	Human-readable name for the credential.
`userId`	string (uuid)	Yes	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.
`createdAt`	string (date-time)	Yes	Timestamp when the credential was created.
`updatedAt`	string (date-time)	Yes	Timestamp when the credential was last updated.
`deletedAt`	string (date-time)	No	Timestamp when the credential was soft-deleted.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/integrations/credentials

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/integrations/credentials/{credentialId}

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/api/integrations/credentials/{credentialId}

Parameters

Path 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.

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)	Yes	Unique identifier for the credential.
`name`	string	Yes	Human-readable name for the credential.
`userId`	string (uuid)	Yes	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.
`createdAt`	string (date-time)	Yes	Timestamp when the credential was created.
`updatedAt`	string (date-time)	Yes	Timestamp when the credential was last updated.
`deletedAt`	string (date-time)	No	Timestamp when the credential was soft-deleted.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/meshmodels/register

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/api/meshmodels/register

Request body

multipart/form-data Required

Schema: object

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.

Schema: object

Field	Type	Required	Description
`message`	string	No	No description provided.

Schema: string

Evaluation POST

/api/meshmodels/relationships/evaluate

Evaluate relationships in a design

Performs relationship evaluation on a given design, applying policies and updating components and relationships as needed. This EvaluationResponse contract is engine-agnostic: it is produced either by this server operation or by an equivalent in-browser WebAssembly engine implementing the same contract. See docs/relationship-evaluation-engine-contract.md for the authoritative engine contract, the in-browser engine surface, and the registry-independent hydration boundary.

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/meshmodels/relationships/evaluate

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/api/meshmodels/relationships/evaluate

Request body

application/json Required

Schema: object

Field	Type	Required	Description
`design`	object	Yes	Designs are your primary tool for collaborative authorship of your infrastructure, workflow, and processes.
`options`	object	No	The options of the evaluationrequest.

Returned data

Responses

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

Schema for the response of a relationship evaluation process in Meshery

Field	Type	Required	Description
`actions`	array of object	Yes	The actions of the evaluationresponse.
`design`	object	Yes	The final evaluated design, including all updated components and relationships. This can be either the complete updated design or only a diff of changes. The version of the design will be automatically incremented if any modifications are made during the evaluation process. This field provides a comprehensive view of the design state after all relationship evaluations and policy applications have been completed.
`evaluationHash`	string	No	Hash of the input parameters and configuration used for this evaluation. Useful for identifying duplicate evaluations or caching results.
`schemaVersion`	string	Yes	Specifies the version of the schema to which the evaluation response conforms.
`timestamp`	string (date-time)	No	ISO 8601 formatted timestamp of when the evaluation was completed.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/pattern/import

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/api/pattern/import

Request body

application/json Required

Body for POST /api/pattern/import. Consumed by the server as application/json. Exactly one of two variants must be supplied: a File Import carrying base64-encoded bytes plus a file name, or a URL Import naming a remote location the server will fetch. Sending both variants at once, or neither, is rejected with 400.

File Import

Upload a design file from the local system. Both file and fileName are required; the server uses the file name to identify the file type (Kubernetes Manifest, Helm Chart, Docker Compose, or Meshery Design).

Field	Type	Required	Description
`file`	string (byte)	Yes	Base64-encoded file bytes. Supported formats: Kubernetes Manifests, Helm Charts, Docker Compose, and Meshery Designs. See Import Designs Documentation for details.
`fileName`	string	Yes	The name of the pattern file being imported. Include the extension (e.g. `design.yaml`), as the server uses it to identify the file type.
`name`	string	No	Provide a name for your design. This name will help you identify the design later. You can also change the name of your design after importing it.

URL Import

Import a design by URL. The server will fetch the resource and derive the file type from the response.

Field	Type	Required	Description
`name`	string	No	Provide a name for your design. This name will help you identify the design later. You can also change the name of your design after importing it.
`url`	string (uri)	Yes	A direct URL to a single file, for example: https://raw.github.com/your-design-file.yaml. Ensure the resource 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.

Schema: object

Field	Type	Required	Description
`message`	string	No	No description provided.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/performance/profiles

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/api/performance/profiles

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.

Paginated list of performance profiles.

Field	Type	Required	Description
`page`	integer	Yes	Zero-based page index returned in this response.
`pageSize`	integer	Yes	Maximum number of items returned on each page.
`profiles`	array of object	Yes	Performance profiles in this page.
`totalCount`	integer	Yes	Total number of performance profiles across all pages.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/performance/profiles

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/api/performance/profiles

Request body

application/json Required

Body for creating or updating a performance profile.

Payload for creating or updating a performance profile. Includes only client-settable fields; server-generated fields (id on create, createdAt, updatedAt, lastRun, totalResults) are populated by the server.

Field	Type	Required	Description
`concurrentRequest`	integer	No	Number of concurrent requests issued by the load generator.
`contentType`	string	No	Content-Type header value applied to each load-test request body (e.g. “application/json”).
`duration`	string	Yes	Duration of the load test, expressed as a Go duration string (e.g. “30s”, “5m”, “1h”).
`endpoints`	array of string	Yes	Endpoints (URLs) targeted by the performance profile’s load test.
`id`	string (uuid)	No	Existing performance-profile ID for updates; omit on create.
`loadGenerators`	array of string	Yes	Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile’s load test.
`metadata`	object	No	Free-form metadata associated with the performance profile.
`name`	string	Yes	Human-readable name of the performance profile.
`qps`	integer	No	Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled.
`requestBody`	string	No	HTTP request body sent on each load-test request.
`requestCookies`	string	No	HTTP request cookies, serialized as JSON, sent on each load-test request.
`requestHeaders`	string	No	HTTP request headers, serialized as JSON, sent on each load-test request.
`schedule`	string \| null (uuid)	No	Optional schedule ID associating the profile with a recurring run.
`serviceMesh`	string	No	Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic.
`userId`	string (uuid)	No	Owner user ID. When omitted, the server infers it from the authenticated user.

Returned data

Responses

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

A performance profile captures the configuration for a load test run by Meshery against one or more service-mesh endpoints. Profiles are owned by a user and can optionally be associated with a recurring schedule. Learn more at https://docs.meshery.io/tasks/performance-management

Field	Type	Required	Description
`id`	string (uuid)	Yes	Unique identifier for the performance profile.
`name`	string	Yes	Human-readable name of the performance profile.
`userId`	string (uuid)	Yes	User ID of the profile owner.
`schedule`	string \| null (uuid)	No	Optional schedule ID associated with this performance profile. Null when the profile is not bound to a recurring schedule.
`loadGenerators`	array of string	No	Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile’s load test.
`endpoints`	array of string	No	Endpoints (URLs) targeted by the performance profile’s load test.
`serviceMesh`	string	No	Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic.
`concurrentRequest`	integer	No	Number of concurrent requests issued by the load generator.
`qps`	integer	No	Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled.
`duration`	string	No	Duration of the load test, expressed as a Go duration string (e.g. “30s”, “5m”, “1h”).
`requestHeaders`	string	No	HTTP request headers, serialized as JSON, sent on each load-test request. Empty string when no headers are configured.
`requestCookies`	string	No	HTTP request cookies, serialized as JSON, sent on each load-test request. Empty string when no cookies are configured.
`requestBody`	string	No	HTTP request body sent on each load-test request. Empty string when no body is configured.
`contentType`	string	No	Content-Type header value applied to each load-test request body (e.g. “application/json”). Empty string when no body is configured.
`metadata`	object	No	Free-form metadata associated with the performance profile.
`lastRun`	string \| null (date-time)	No	Server-computed timestamp of the most recent load-test run that used this profile. Null until the first run completes. Server-managed; clients must not set this on create/update.
`totalResults`	integer	No	Server-computed count of load-test results recorded for this profile. Server-managed; clients must not set this on create/update.
`createdAt`	string (date-time)	Yes	Timestamp when the performance profile was created.
`updatedAt`	string (date-time)	Yes	Timestamp when the performance profile was last updated.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/performance/profiles/{performanceProfileId}

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/api/performance/profiles/{performanceProfileId}

Parameters

Path parameters

Name	Type	Required	Description
`performanceProfileId`	string (uuid)	Yes	Performance profile ID.

Returned data

Responses

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

A performance profile captures the configuration for a load test run by Meshery against one or more service-mesh endpoints. Profiles are owned by a user and can optionally be associated with a recurring schedule. Learn more at https://docs.meshery.io/tasks/performance-management

Field	Type	Required	Description
`id`	string (uuid)	Yes	Unique identifier for the performance profile.
`name`	string	Yes	Human-readable name of the performance profile.
`userId`	string (uuid)	Yes	User ID of the profile owner.
`schedule`	string \| null (uuid)	No	Optional schedule ID associated with this performance profile. Null when the profile is not bound to a recurring schedule.
`loadGenerators`	array of string	No	Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile’s load test.
`endpoints`	array of string	No	Endpoints (URLs) targeted by the performance profile’s load test.
`serviceMesh`	string	No	Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic.
`concurrentRequest`	integer	No	Number of concurrent requests issued by the load generator.
`qps`	integer	No	Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled.
`duration`	string	No	Duration of the load test, expressed as a Go duration string (e.g. “30s”, “5m”, “1h”).
`requestHeaders`	string	No	HTTP request headers, serialized as JSON, sent on each load-test request. Empty string when no headers are configured.
`requestCookies`	string	No	HTTP request cookies, serialized as JSON, sent on each load-test request. Empty string when no cookies are configured.
`requestBody`	string	No	HTTP request body sent on each load-test request. Empty string when no body is configured.
`contentType`	string	No	Content-Type header value applied to each load-test request body (e.g. “application/json”). Empty string when no body is configured.
`metadata`	object	No	Free-form metadata associated with the performance profile.
`lastRun`	string \| null (date-time)	No	Server-computed timestamp of the most recent load-test run that used this profile. Null until the first run completes. Server-managed; clients must not set this on create/update.
`totalResults`	integer	No	Server-computed count of load-test results recorded for this profile. Server-managed; clients must not set this on create/update.
`createdAt`	string (date-time)	Yes	Timestamp when the performance profile was created.
`updatedAt`	string (date-time)	Yes	Timestamp when the performance profile was last updated.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/performance/profiles/{performanceProfileId}

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/api/performance/profiles/{performanceProfileId}

Parameters

Path parameters

Name	Type	Required	Description
`performanceProfileId`	string (uuid)	Yes	Performance profile ID.

Request body

application/json Required

Body for creating or updating a performance profile.

Payload for creating or updating a performance profile. Includes only client-settable fields; server-generated fields (id on create, createdAt, updatedAt, lastRun, totalResults) are populated by the server.

Field	Type	Required	Description
`concurrentRequest`	integer	No	Number of concurrent requests issued by the load generator.
`contentType`	string	No	Content-Type header value applied to each load-test request body (e.g. “application/json”).
`duration`	string	Yes	Duration of the load test, expressed as a Go duration string (e.g. “30s”, “5m”, “1h”).
`endpoints`	array of string	Yes	Endpoints (URLs) targeted by the performance profile’s load test.
`id`	string (uuid)	No	Existing performance-profile ID for updates; omit on create.
`loadGenerators`	array of string	Yes	Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile’s load test.
`metadata`	object	No	Free-form metadata associated with the performance profile.
`name`	string	Yes	Human-readable name of the performance profile.
`qps`	integer	No	Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled.
`requestBody`	string	No	HTTP request body sent on each load-test request.
`requestCookies`	string	No	HTTP request cookies, serialized as JSON, sent on each load-test request.
`requestHeaders`	string	No	HTTP request headers, serialized as JSON, sent on each load-test request.
`schedule`	string \| null (uuid)	No	Optional schedule ID associating the profile with a recurring run.
`serviceMesh`	string	No	Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic.
`userId`	string (uuid)	No	Owner user ID. When omitted, the server infers it from the authenticated user.

Returned data

Responses

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

A performance profile captures the configuration for a load test run by Meshery against one or more service-mesh endpoints. Profiles are owned by a user and can optionally be associated with a recurring schedule. Learn more at https://docs.meshery.io/tasks/performance-management

Field	Type	Required	Description
`id`	string (uuid)	Yes	Unique identifier for the performance profile.
`name`	string	Yes	Human-readable name of the performance profile.
`userId`	string (uuid)	Yes	User ID of the profile owner.
`schedule`	string \| null (uuid)	No	Optional schedule ID associated with this performance profile. Null when the profile is not bound to a recurring schedule.
`loadGenerators`	array of string	No	Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile’s load test.
`endpoints`	array of string	No	Endpoints (URLs) targeted by the performance profile’s load test.
`serviceMesh`	string	No	Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic.
`concurrentRequest`	integer	No	Number of concurrent requests issued by the load generator.
`qps`	integer	No	Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled.
`duration`	string	No	Duration of the load test, expressed as a Go duration string (e.g. “30s”, “5m”, “1h”).
`requestHeaders`	string	No	HTTP request headers, serialized as JSON, sent on each load-test request. Empty string when no headers are configured.
`requestCookies`	string	No	HTTP request cookies, serialized as JSON, sent on each load-test request. Empty string when no cookies are configured.
`requestBody`	string	No	HTTP request body sent on each load-test request. Empty string when no body is configured.
`contentType`	string	No	Content-Type header value applied to each load-test request body (e.g. “application/json”). Empty string when no body is configured.
`metadata`	object	No	Free-form metadata associated with the performance profile.
`lastRun`	string \| null (date-time)	No	Server-computed timestamp of the most recent load-test run that used this profile. Null until the first run completes. Server-managed; clients must not set this on create/update.
`totalResults`	integer	No	Server-computed count of load-test results recorded for this profile. Server-managed; clients must not set this on create/update.
`createdAt`	string (date-time)	Yes	Timestamp when the performance profile was created.
`updatedAt`	string (date-time)	Yes	Timestamp when the performance profile was last updated.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/performance/profiles/{performanceProfileId}

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/api/performance/profiles/{performanceProfileId}

Parameters

Path parameters

Name	Type	Required	Description
`performanceProfileId`	string (uuid)	Yes	Performance profile ID.

Returned data

Responses

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

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/performance/profiles/{performanceProfileId}/results

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/api/performance/profiles/{performanceProfileId}/results

Parameters

Path parameters

Name	Type	Required	Description
`performanceProfileId`	string (uuid)	Yes	Performance profile 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.

Paginated list of performance results.

Field	Type	Required	Description
`page`	integer	Yes	Zero-based page index returned in this response.
`pageSize`	integer	Yes	Maximum number of items returned on each page.
`results`	array of object	Yes	Performance results in this page.
`totalCount`	integer	Yes	Total number of performance results across all pages.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/performance/results

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/api/performance/results

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
`from`	string (date)	No	Start date for filtering results by test start time, in YYYY-MM-DD format.
`to`	string (date)	No	End date for filtering results by test start time, in YYYY-MM-DD format.

Returned data

Responses

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

Paginated list of performance results.

Field	Type	Required	Description
`page`	integer	Yes	Zero-based page index returned in this response.
`pageSize`	integer	Yes	Maximum number of items returned on each page.
`results`	array of object	Yes	Performance results in this page.
`totalCount`	integer	Yes	Total number of performance results across all pages.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/system/database

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/api/system/database

Parameters

Query parameters

Name	Type	Required	Description
`page`	integer	No	Zero-based page index for the table list.
`pageSize`	integer	No	Number of tables to include per page.
`search`	string	No	Substring filter applied to table names.
`sort`	string	No	Column to order the table list by.
`order`	string	No	Sort direction for the `sort` column.

Returned data

Responses

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

Paginated summary of the Meshery server’s embedded database.

Field	Type	Required	Description
`page`	integer	Yes	Zero-based page index of the returned table slice.
`pageSize`	integer	Yes	Number of tables included in this page.
`recordCount`	integer	Yes	Aggregate row count across the tables returned in this page.
`tables`	array of object	Yes	Tables included in this page, with per-table row counts.
`totalTables`	integer	Yes	Total number of tables in the database matching the search filter.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/system/database/reset

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/api/system/database/reset

Returned data

Responses

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

Status message response.

Field	Type	Required	Description
`message`	string	Yes	Human-readable status message.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/system/sync

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/api/system/sync

Returned data

Responses

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

Session bootstrap payload for the authenticated user.

Field	Type	Required	Description
`k8sConfig`	array of object	No	Kubernetes contexts currently tracked by the Meshery server.

Schema: string

Authentication

No authentication required

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/system/version

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/api/system/version

Returned data

Responses

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

Version metadata for a running Meshery service.

Field	Type	Required	Description
`build`	string	No	Build identifier (typically the git tag of the running binary).
`commitsha`	string	No	Git commit SHA of the running service. The wire field is `commitsha`.
`latest`	string	No	Latest available Meshery release tag fetched from GitHub.
`outdated`	boolean	No	True when the running build is older than the latest available release.
`releaseChannel`	string	No	Release channel of the running binary (e.g. `stable`, `edge`).
`version`	string	No	Meshery Cloud deployment version.

Authentication

No authentication required

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/users

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/api/users

Parameters

Query parameters

Name	Type	Required	Description
`page`	string	No	Get responses by page
`pageSize`	string	No	Get responses by page size
`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.
`pageSize`	integer	No	Number of items per page.
`totalCount`	integer	No	Total number of items available.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/workspaces

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/api/workspaces

Parameters

Query parameters

Name	Type	Required	Description
`orgId`	string (uuid)	No	Organization ID used to scope the workspace listing.
`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	Zero-based page index returned in this response.
`pageSize`	integer	No	Maximum number of items returned on each page.
`totalCount`	integer	No	Total number of items across all pages.
`workspaces`	array of object	No	List of workspaces with resolved owner details.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/workspaces

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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.
`organizationId`	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
`createdAt`	string (date-time)	Yes	Timestamp when the workspace was created.
`deletedAt`	string (date-time)	No	Timestamp when the workspace was soft-deleted. Null while the workspace is active.
`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.
`organizationId`	string (uuid)	Yes	Organization to which this workspace belongs.
`owner`	string (uuid)	No	User ID of the workspace owner.
`updatedAt`	string (date-time)	Yes	Timestamp when the workspace was last updated.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/workspaces/{workspaceId}

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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
`createdAt`	string (date-time)	Yes	Timestamp when the workspace was created.
`deletedAt`	string (date-time)	No	Timestamp when the workspace was soft-deleted. Null while the workspace is active.
`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.
`organizationId`	string (uuid)	Yes	Organization to which this workspace belongs.
`owner`	string (uuid)	No	User ID of the workspace owner.
`updatedAt`	string (date-time)	Yes	Timestamp when the workspace was last updated.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/workspaces/{workspaceId}

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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.
`organizationId`	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
`createdAt`	string (date-time)	Yes	Timestamp when the workspace was created.
`deletedAt`	string (date-time)	No	Timestamp when the workspace was soft-deleted. Null while the workspace is active.
`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.
`organizationId`	string (uuid)	Yes	Organization to which this workspace belongs.
`owner`	string (uuid)	No	User ID of the workspace owner.
`updatedAt`	string (date-time)	Yes	Timestamp when the workspace was last updated.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/workspaces/{workspaceId}

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/workspaces/{workspaceId}/designs

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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	Zero-based page index returned in this response.
`pageSize`	integer	No	Maximum number of items returned on each page.
`totalCount`	integer	No	Total number of items across all pages.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/workspaces/{workspaceId}/designs/{designId}

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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	Zero-based page index returned in this response.
`pageSize`	integer	No	Maximum number of items returned on each page.
`totalCount`	integer	No	Total number of items across all pages.
`workspacesDesignsMapping`	array of object	No	Workspace-design mapping entries.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/workspaces/{workspaceId}/designs/{designId}

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/workspaces/{workspaceId}/environments

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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.

Paginated list of environments.

Field	Type	Required	Description
`environments`	array of object	No	Environments associated with this resource.
`page`	integer	No	Zero-based page index returned in this response.
`pageSize`	integer	No	Maximum number of items returned on each page.
`totalCount`	integer	No	Total number of items across all pages.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/workspaces/{workspaceId}/environments/{environmentId}

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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	Zero-based page index returned in this response.
`pageSize`	integer	No	Maximum number of items returned on each page.
`totalCount`	integer	No	Total number of items across all pages.
`workspacesEnvironmentsMapping`	array of object	No	Workspace-environment mapping entries.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/workspaces/{workspaceId}/environments/{environmentId}

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/workspaces/{workspaceId}/teams

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/workspaces/{workspaceId}/teams/{teamId}

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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	Zero-based page index returned in this response.
`pageSize`	integer	No	Maximum number of items returned on each page.
`totalCount`	integer	No	Total number of items across all pages.
`workspacesTeamsMapping`	array of object	No	Workspace-team mapping entries.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/workspaces/{workspaceId}/teams/{teamId}

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/workspaces/{workspaceId}/views

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/workspaces/{workspaceId}/views/{viewId}

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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	Zero-based page index returned in this response.
`pageSize`	integer	No	Maximum number of items returned on each page.
`totalCount`	integer	No	Total number of items across all pages.
`workspacesViewsMapping`	array of object	No	Workspace-view mapping entries.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/api/workspaces/{workspaceId}/views/{viewId}

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/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.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/events

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/events

Request body

application/json Required

Payload for creating a new event.

Field	Type	Required	Description
`action`	string	No	The action of the event.
`category`	string	No	The category of the event.
`description`	string	No	Description of the event.
`userId`	string (uuid)	No	UUID of the user associated with the event.

Returned data

Responses

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

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/events/delete

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/events/delete

Request body

application/json Required

Payload for bulk-deleting events by ID.

Field	Type	Required	Description
`ids`	array of string (uuid)	Yes	UUIDs of the events to delete.

Returned data

Responses

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

Response body returned after bulk event deletion.

Field	Type	Required	Description
`deleted`	array of string (uuid)	No	UUIDs of events that were deleted.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/events/status

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/events/status

Request body

application/json Required

Payload for bulk-updating the status of events.

Field	Type	Required	Description
`ids`	array of string (uuid)	Yes	UUIDs of the events to update.
`status`	string	Yes	New status to apply to the selected events.

Returned data

Responses

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

Response body returned after bulk event status update.

Field	Type	Required	Description
`updated`	array of string (uuid)	No	UUIDs of events whose status was updated.

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/events/{eventId}

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/events/{eventId}

Parameters

Path parameters

Name	Type	Required	Description
`eventId`	string (uuid)	Yes	ID of the event.

Returned data

Responses

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

Schema: string

Try this endpoint

Use your Meshery hostname or local server URL when calling this endpoint.

Meshery Playground server URL

https://playground.meshery.io/events/{eventId}/status

Meshery Server URL (controlled via PORT environment variable)

http://localhost:9081/events/{eventId}/status

Parameters

Path parameters

Name	Type	Required	Description
`eventId`	string (uuid)	Yes	ID of the event.

Request body

application/json Required

Payload for updating the status of a single event.

Field	Type	Required	Description
`status`	string	Yes	Current status of the event.

Returned data

Responses

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

Response body returned after updating an event’s status.

Field	Type	Required	Description
`eventId`	string (uuid)	No	UUID of the event whose status was updated.
`message`	string	No	Human-readable status message.
`status`	string	No	Updated status of the event.

Schema: string