REST API Reference

Try this endpoint

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

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

http://localhost:9876/api/environments

Parameters

Query parameters

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

Returned data

Responses

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

Schema: object

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

Schema: string

Try this endpoint

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

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

http://localhost:9876/api/environments

Request body

application/json Required

Body for creating environment

Schema: object

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

Returned data

Responses

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

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

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

Example response

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

Schema: string

Try this endpoint

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

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

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

Parameters

Path parameters

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

Query parameters

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

Returned data

Responses

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

Schema: object

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

Schema: string

Try this endpoint

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

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

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

Parameters

Path parameters

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

Request body

application/json Required

Body for creating environment

Schema: object

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

Returned data

Responses

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

Schema: object

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

Schema: string

Try this endpoint

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

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

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

Parameters

Path parameters

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

Returned data

Responses

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

Schema: string

Try this endpoint

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

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

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

Parameters

Path parameters

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

Query parameters

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

Returned data

Responses

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

Schema: object

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

Schema: string

Try this endpoint

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

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

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

Parameters

Path parameters

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

Returned data

Responses

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

Schema: string

Try this endpoint

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

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

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

Parameters

Path parameters

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

Returned data

Responses

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

Schema: string

Authentication

Bearer JWT

Try this endpoint

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

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

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

Parameters

Query parameters

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

Returned data

Responses

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

Schema: object

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

Schema: string

Authentication

Bearer JWT

Try this endpoint

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

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

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

Request body

application/json Required

Body for creating or updating an organization

Schema: object

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

Returned data

Responses

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

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

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

Schema: string

Try this endpoint

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

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

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

Parameters

Query parameters

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

Returned data

Responses

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

Schema: object

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

Schema: string

Authentication

Bearer JWT

Try this endpoint

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

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

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

Parameters

Path parameters

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

Returned data

Responses

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

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

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

Schema: string

Authentication

Bearer JWT

Try this endpoint

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

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

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

Parameters

Path parameters

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

Request body

application/json Required

Body for creating or updating an organization

Schema: object

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

Returned data

Responses

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

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

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

Schema: string

Authentication

Bearer JWT

Try this endpoint

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

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

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

Parameters

Path parameters

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

Returned data

Responses

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

Schema: string

Authentication

Bearer JWT

Try this endpoint

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

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

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

Parameters

Path parameters

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

Returned data

Responses

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

Schema: object

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

Schema: string

Try this endpoint

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

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

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

Parameters

Path parameters

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

Query parameters

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

Returned data

Responses

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

Paginated list of teams

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

Schema: string

Try this endpoint

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

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

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

Parameters

Path parameters

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

Request body

application/json Required

Body for creating a team

Payload for creating a new team

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

Returned data

Responses

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

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

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

Schema: string

Try this endpoint

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

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

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

Parameters

Path parameters

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

Returned data

Responses

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

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

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

Schema: string

Authentication

Bearer JWT

Try this endpoint

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

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

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

Parameters

Path parameters

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

Request body

application/json Optional

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

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

Returned data

Responses

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

Schema: one of object

object

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

object

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

Try this endpoint

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

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

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

Parameters

Path parameters

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

Request body

application/json Required

Body for updating a team

Payload for updating an existing team

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

Returned data

Responses

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

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

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

Schema: string

Try this endpoint

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

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

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

Parameters

Path parameters

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

Returned data

Responses

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

Schema: string

Authentication

Bearer JWT

Try this endpoint

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

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

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

Parameters

Path parameters

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

Returned data

Responses

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

Schema: object

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

Try this endpoint

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

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

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

Parameters

Path parameters

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

Query parameters

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

Returned data

Responses

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

Schema: object

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 Cloud development server URL (controlled via PORT environment variable)

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

Parameters

Path parameters

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

Returned data

Responses

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

Mapping between teams and users

Field	Type	Required	Description
`created_at`	string (date-time)	No	Timestamp when the resource was created.
`deleted_at`	string (date-time)	No	SQL null Timestamp to handle null values of time.
`id`	string (uuid)	No	No description provided.
`team_id`	string (uuid)	No	No description provided.
`updated_at`	string (date-time)	No	Timestamp when the resource was updated.
`user_id`	string	No	user’s email or username

Schema: string

Try this endpoint

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

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

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

Parameters

Path parameters

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

Returned data

Responses

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

Schema: string

Try this endpoint

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

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

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

Parameters

Path parameters

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

Query parameters

Name	Type	Required	Description
`page`	string	No	Get responses by page
`pagesize`	string	No	Get responses by pagesize
`search`	string	No	Get responses that match search param value
`order`	string	No	Get ordered responses
`filter`	string	No	Get filtered reponses
`teamId`	string (uuid)	No	Optional team filter when listing organization users

Returned data

Responses

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

Paginated list of users with organization and team role context

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

Schema: string

Try this endpoint

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

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

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

Parameters

Path parameters

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

Query parameters

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

Returned data

Responses

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

Schema: object

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

Schema: string

Authentication

Bearer JWT

Try this endpoint

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

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

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

Parameters

Path parameters

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

Returned data

Responses

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

Schema: object

Schema: string

Authentication

Bearer JWT

Try this endpoint

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

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

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

Parameters

Path parameters

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

Returned data

Responses

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

Schema: string

Try this endpoint

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

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

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

Parameters

Path parameters

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

Query parameters

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

Returned data

Responses

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

Paginated list of team-user mappings

Field	Type	Required	Description
`page`	integer	No	No description provided.
`page_size`	integer	No	No description provided.
`teamsUsersMapping`	array of object	No	The teams users mapping of the teamsusersmappingpage.
`total_count`	integer	No	No description provided.

Schema: string

Try this endpoint

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

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

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

Returned data

Responses

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

Represents a user in Layer5 Cloud (Meshery)

Field	Type	Required	Description
`accepted_terms_at`	string (date-time)	No	Timestamp when user accepted terms and conditions
`avatar_url`	string (uri)	No	URL to user’s avatar image
`bio`	string	No	User’s biography or description
`country`	object	No	User’s country information stored as JSONB
`created_at`	string (date-time)	Yes	Timestamp when the user record was created
`deleted_at`	string \| null (date-time)	Yes	Timestamp when the user record was soft-deleted (null if not deleted)
`email`	string (email)	Yes	User’s email address
`first_login_time`	string (date-time)	No	Timestamp of user’s first login
`first_name`	string	Yes	User’s first name
`id`	string (uuid)	Yes	Unique identifier for the user
`last_login_time`	string (date-time)	Yes	Timestamp of user’s most recent login
`last_name`	string	Yes	User’s last name
`organizations`	object	No	Organizations the user belongs to with role information
`preferences`	object	No	User preferences stored as JSONB
`provider`	string	Yes	Authentication provider (e.g., Layer5 Cloud, Twitter, Facebook, Github)
`region`	object	No	User’s region information stored as JSONB
`role_names`	array of string	No	List of global roles assigned to the user
`socials`	array of object	No	Various online profiles associated with the user account
`status`	string	Yes	User account status
`teams`	object	No	Teams the user belongs to with role information
`updated_at`	string (date-time)	Yes	Timestamp when the user record was last updated
`user_id`	string	Yes	User identifier (username or external ID)

Schema: string

Try this endpoint

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

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

http://localhost:9876/api/identity/users/profile/{id}

Parameters

Path parameters

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

Returned data

Responses

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

Represents a user in Layer5 Cloud (Meshery)

Field	Type	Required	Description
`accepted_terms_at`	string (date-time)	No	Timestamp when user accepted terms and conditions
`avatar_url`	string (uri)	No	URL to user’s avatar image
`bio`	string	No	User’s biography or description
`country`	object	No	User’s country information stored as JSONB
`created_at`	string (date-time)	Yes	Timestamp when the user record was created
`deleted_at`	string \| null (date-time)	Yes	Timestamp when the user record was soft-deleted (null if not deleted)
`email`	string (email)	Yes	User’s email address
`first_login_time`	string (date-time)	No	Timestamp of user’s first login
`first_name`	string	Yes	User’s first name
`id`	string (uuid)	Yes	Unique identifier for the user
`last_login_time`	string (date-time)	Yes	Timestamp of user’s most recent login
`last_name`	string	Yes	User’s last name
`organizations`	object	No	Organizations the user belongs to with role information
`preferences`	object	No	User preferences stored as JSONB
`provider`	string	Yes	Authentication provider (e.g., Layer5 Cloud, Twitter, Facebook, Github)
`region`	object	No	User’s region information stored as JSONB
`role_names`	array of string	No	List of global roles assigned to the user
`socials`	array of object	No	Various online profiles associated with the user account
`status`	string	Yes	User account status
`teams`	object	No	Teams the user belongs to with role information
`updated_at`	string (date-time)	Yes	Timestamp when the user record was last updated
`user_id`	string	Yes	User identifier (username or external ID)

Schema: string

Try this endpoint

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

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

http://localhost:9876/api/integrations/connections

Parameters

Query parameters

Name	Type	Required	Description
`page`	integer	No	Page number
`pagesize`	integer	No	Number of items per page
`search`	string	No	Search term
`order`	string	No	Sort order
`filter`	string	No	Filter connections (general filter string)
`kind`	array of string	No	Filter by connection kind (e.g., kubernetes, prometheus, grafana)
`status`	array of string	No	Filter by connection status
`type`	array of string	No	Filter by connection type
`name`	string	No	Filter by connection name (partial match supported)

Returned data

Responses

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

Represents a page of connections with meta information about connections count

Field	Type	Required	Description
`connections`	array of object	Yes	List of connections on this page
`total_count`	integer	Yes	Total number of connections on all pages
`page`	integer	Yes	Current page number
`page_size`	integer	Yes	Number of elements per page
`statusSummary`	object	No	Aggregate count of connections grouped by status

Schema: string

Try this endpoint

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

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

http://localhost:9876/api/integrations/connections

Request body

application/json Required

Payload for creating or updating a connection

Field	Type	Required	Description
`credentialId`	string (uuid)	No	Associated credential ID
`credentialSecret`	object	No	Credential secret data
`id`	string (uuid)	No	Connection ID
`kind`	string	Yes	Connection kind
`metadata`	object	No	Connection metadata
`name`	string	Yes	Connection name
`status`	string	Yes	Connection status
`subType`	string	Yes	Connection sub-type
`type`	string	Yes	Connection type

Returned data

Responses

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

Meshery Connections are managed and unmanaged resources that either through discovery or manual entry are tracked by Meshery. Learn more at https://docs.meshery.io/concepts/logical/connections

Field	Type	Required	Description
`id`	string (uuid)	Yes	Connection ID
`name`	string	Yes	Connection Name
`credential_id`	string (uuid)	No	Associated Credential ID
`type`	string	Yes	Connection Type (platform, telemetry, collaboration)
`sub_type`	string	Yes	Connection Subtype (cloud, identity, metrics, chat, git, orchestration)
`kind`	string	Yes	Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github)
`metadata`	object	No	Additional connection metadata
`status`	string	Yes	Connection Status
`user_id`	string (uuid)	No	User ID who owns this connection
`created_at`	string (date-time)	No	No description provided.
`updated_at`	string (date-time)	No	No description provided.
`deleted_at`	string (date-time)	No	SQL null Timestamp to handle null values of time.
`environments`	array of object	No	Associated environments for this connection
`schemaVersion`	string	Yes	Specifies the version of the schema used for the definition.

Schema: string

Try this endpoint

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

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

http://localhost:9876/api/integrations/connections/kubernetes/{connectionId}/context

Parameters

Path parameters

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

Returned data

Responses

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

Schema: object

Schema: string

Try this endpoint

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

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

http://localhost:9876/api/integrations/connections/meshery/{mesheryServerId}

Parameters

Path parameters

Name	Type	Required	Description
`mesheryServerId`	string (uuid)	Yes	Meshery server ID

Returned data

Responses

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

Schema: string

Try this endpoint

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

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

http://localhost:9876/api/integrations/connections/{connectionId}

Parameters

Path parameters

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

Returned data

Responses

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

Meshery Connections are managed and unmanaged resources that either through discovery or manual entry are tracked by Meshery. Learn more at https://docs.meshery.io/concepts/logical/connections

Field	Type	Required	Description
`id`	string (uuid)	Yes	Connection ID
`name`	string	Yes	Connection Name
`credential_id`	string (uuid)	No	Associated Credential ID
`type`	string	Yes	Connection Type (platform, telemetry, collaboration)
`sub_type`	string	Yes	Connection Subtype (cloud, identity, metrics, chat, git, orchestration)
`kind`	string	Yes	Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github)
`metadata`	object	No	Additional connection metadata
`status`	string	Yes	Connection Status
`user_id`	string (uuid)	No	User ID who owns this connection
`created_at`	string (date-time)	No	No description provided.
`updated_at`	string (date-time)	No	No description provided.
`deleted_at`	string (date-time)	No	SQL null Timestamp to handle null values of time.
`environments`	array of object	No	Associated environments for this connection
`schemaVersion`	string	Yes	Specifies the version of the schema used for the definition.

Schema: string

Try this endpoint

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

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

http://localhost:9876/api/integrations/connections/{connectionId}

Parameters

Path parameters

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

Request body

application/json Required

Payload for creating or updating a connection

Field	Type	Required	Description
`credentialId`	string (uuid)	No	Associated credential ID
`credentialSecret`	object	No	Credential secret data
`id`	string (uuid)	No	Connection ID
`kind`	string	Yes	Connection kind
`metadata`	object	No	Connection metadata
`name`	string	Yes	Connection name
`status`	string	Yes	Connection status
`subType`	string	Yes	Connection sub-type
`type`	string	Yes	Connection type

Returned data

Responses

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

Meshery Connections are managed and unmanaged resources that either through discovery or manual entry are tracked by Meshery. Learn more at https://docs.meshery.io/concepts/logical/connections

Field	Type	Required	Description
`id`	string (uuid)	Yes	Connection ID
`name`	string	Yes	Connection Name
`credential_id`	string (uuid)	No	Associated Credential ID
`type`	string	Yes	Connection Type (platform, telemetry, collaboration)
`sub_type`	string	Yes	Connection Subtype (cloud, identity, metrics, chat, git, orchestration)
`kind`	string	Yes	Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github)
`metadata`	object	No	Additional connection metadata
`status`	string	Yes	Connection Status
`user_id`	string (uuid)	No	User ID who owns this connection
`created_at`	string (date-time)	No	No description provided.
`updated_at`	string (date-time)	No	No description provided.
`deleted_at`	string (date-time)	No	SQL null Timestamp to handle null values of time.
`environments`	array of object	No	Associated environments for this connection
`schemaVersion`	string	Yes	Specifies the version of the schema used for the definition.

Schema: string

Try this endpoint

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

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

http://localhost:9876/api/integrations/connections/{connectionId}

Parameters

Path parameters

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

Returned data

Responses

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

Schema: string

Try this endpoint

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

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

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

Try this endpoint

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

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

http://localhost:9876/api/pattern/import

Request body

multipart/form-data Required

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

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

Returned data

Responses

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

Schema: object

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

Schema: string

Authentication

No authentication required

Try this endpoint

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

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

http://localhost:9876/api/users

Parameters

Query parameters

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

Returned data

Responses

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

Paginated list of public user records

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

Schema: string

Try this endpoint

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

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

http://localhost:9876/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 Cloud development server URL (controlled via PORT environment variable)

http://localhost:9876/events

Request body

application/json Required

Schema: object

Returned data

Responses

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

Schema: string

Try this endpoint

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

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

http://localhost:9876/events/delete

Request body

application/json Required

Schema: object

Field	Type	Required	Description
`ids`	array of string (uuid)	Yes	The ids of the bulkdeleterequest.

Returned data

Responses

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

Schema: object

Field	Type	Required	Description
`deleted`	array of string (uuid)	No	No description provided.

Schema: string

Try this endpoint

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

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

http://localhost:9876/events/status

Request body

application/json Required

Schema: object

Field	Type	Required	Description
`ids`	array of string (uuid)	Yes	The ids of the bulkupdatestatusrequest.
`status`	string	Yes	Current status of the resource.

Returned data

Responses

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

Schema: object

Field	Type	Required	Description
`updated`	array of string (uuid)	No	No description provided.

Schema: string

Try this endpoint

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

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

http://localhost:9876/events/{id}

Parameters

Path parameters

Name	Type	Required	Description
`id`	string (uuid)	Yes	ID of the event to delete

Returned data

Responses

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

Schema: string

Try this endpoint

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

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

http://localhost:9876/events/{id}/status

Parameters

Path parameters

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

Request body

application/json Required

Schema: object

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

Returned data

Responses

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

Schema: object

Field	Type	Required	Description
`event_id`	string (uuid)	No	No description provided.
`message`	string	No	No description provided.
`status`	string	No	No description provided.

Schema: string