REST API Reference

Meshery’s APIs

Each of Meshery’s APIs are subject to the following authentication and authorization system. Meshery requires a valid token in order to allow clients to invoke its APIs.

AuthenticationRequests to any of the API endpoints must be authenticated and include a valid JWT access token in the HTTP headers. The type of authentication is determined by the selected Providers. Use of the Local Provider, "None", puts Meshery into single-user mode and uses minimal, intentionally insecure authentication.

How to get your token

There are two ways to get your authentication token:

Meshery UI

Using Meshery UI, you can get a copy of your authentication token by following these steps:

  1. Log into Meshery by selecting your identity provider of choice (typically found at http:\{meshery-server}:9081/provider)

  2. Navigate to your user’s avatar in the upper righthand corner and select “Get Token” from the dropdown of profile section:

Meshery Dashboard

Meshery CLI
Using Meshery CLI, you can get a copy of your authentication token by executing the following command:

  
mesheryctl system login


In order to use this command, you must have a web browser available on your system (this command cannot be executed on a headless system).

How to access Meshery’s REST API

Example using curl
Using curl, you can access Meshery's REST API by executing this command:

  
curl --location 'localhost:9081/api/<endpoint>' \
--header 'meshery-token: <yourToken>\
--header 'Cookie: meshery-provider=Layer5; cloud.layer5.io_ref=/;token=<yourToken>


Endpoints

This section contains API reference content derived from Meshery’s OpenAPI specification.

Meshery REST API reference

Browse 57 api endpoints grouped by resource. Review the complete REST API schema for the full OpenAPI document.

GET Environments

/api/environments

Get all environments

Gets all environments
Authentication
Bearer JWT

Try This Endpoint

Server URLs

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

http://localhost:9081/api/environments

Parameters

Query parameters

NameTypeRequiredDescription
searchstringNoGet responses that match search param value
orderstringNoGet ordered responses
pagestringNoGet responses by page
pagesizestringNoGet responses by pagesize
orgIDstringYesUser’s organization ID

Returned Data

Responses

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

200
Environments

application/json

Schema: object

FieldTypeRequiredDescription
environmentsarray of objectNoNo description provided.
pageintegerNoNo description provided.
page_sizeintegerNoNo description provided.
total_countintegerNoNo description provided.
401
Expired JWT token used or insufficient privilege

text/plain

Schema: string

Schema: string

500
Internal server error

text/plain

Schema: string

Schema: string

POST Environments

/api/environments

Create an environment

Creates a new environment
Authentication
Bearer JWT

Try This Endpoint

Server URLs

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

http://localhost:9081/api/environments

Request body

Body for creating environment

application/json

Schema: object

Required
FieldTypeRequiredDescription
descriptionstringNoAn 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.
namestringYesAn 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.
OrganizationIDstringNoSelect 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.

201
Created environment

application/json

Schema: object

Environments allow you to logically group related Connections and their associated Credentials. Learn more at https://docs.meshery.io/concepts/logical/environments
FieldTypeRequiredDescription
idstring (uuid)YesID
schemaVersionstringYesSpecifies the version of the schema to which the environment conforms.
namestringYesEnvironment name
descriptionstringYesEnvironment description
organization_idstring (uuid)YesEnvironment organization ID
ownerstring (uuid)NoEnvironment owner
created_atstring (date-time)NoTimestamp when the resource was created.
metadataobjectNoAdditional metadata associated with the environment.
updated_atstring (date-time)NoTimestamp when the resource was updated.
deleted_atstring | null (date-time)NoTimestamp 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"
}
400
Invalid request body or request param

text/plain

Schema: string

Schema: string

500
Internal server error

text/plain

Schema: string

Schema: string

GET Environments

/api/environments/{environmentId}

Get environment by ID

Authentication
Bearer JWT

Try This Endpoint

Server URLs

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

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

Parameters

Path parameters

NameTypeRequiredDescription
environmentIdstring (uuid)YesEnvironment ID

Query parameters

NameTypeRequiredDescription
orgIDstringYesUser’s organization ID

Returned Data

Responses

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

200
Environment page

application/json

Schema: object

FieldTypeRequiredDescription
environmentsarray of objectNoNo description provided.
pageintegerNoNo description provided.
page_sizeintegerNoNo description provided.
total_countintegerNoNo description provided.
400
Invalid request body or request param

text/plain

Schema: string

Schema: string

401
Expired JWT token used or insufficient privilege

text/plain

Schema: string

Schema: string

404
Expired JWT token used or insufficient privilege

text/plain

Schema: string

Schema: string

500
Internal server error

text/plain

Schema: string

Schema: string

PUT Environments

/api/environments/{environmentId}

Update an environment

Authentication
Bearer JWT

Try This Endpoint

Server URLs

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

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

Parameters

Path parameters

NameTypeRequiredDescription
environmentIdstring (uuid)YesEnvironment ID

Request body

Body for creating environment

application/json

Schema: object

Required
FieldTypeRequiredDescription
descriptionstringNoAn 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.
namestringYesAn 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.
OrganizationIDstringNoSelect 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.

200
Environment page

application/json

Schema: object

FieldTypeRequiredDescription
environmentsarray of objectNoNo description provided.
pageintegerNoNo description provided.
page_sizeintegerNoNo description provided.
total_countintegerNoNo description provided.
400
Invalid request body or request param

text/plain

Schema: string

Schema: string

401
Expired JWT token used or insufficient privilege

text/plain

Schema: string

Schema: string

500
Internal server error

text/plain

Schema: string

Schema: string

DELETE Environments

/api/environments/{environmentId}

Delete an environment

Authentication
Bearer JWT

Try This Endpoint

Server URLs

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

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

Parameters

Path parameters

NameTypeRequiredDescription
environmentIdstring (uuid)YesEnvironment ID

Returned Data

Responses

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

200
Environment page

application/json

Schema: object

FieldTypeRequiredDescription
environmentsarray of objectNoNo description provided.
pageintegerNoNo description provided.
page_sizeintegerNoNo description provided.
total_countintegerNoNo description provided.
400
Invalid request body or request param

text/plain

Schema: string

Schema: string

401
Expired JWT token used or insufficient privilege

text/plain

Schema: string

Schema: string

500
Internal server error

text/plain

Schema: string

Schema: string

GET Environments

/api/environments/{environmentId}/connections

Get environment connections

Authentication
Bearer JWT

Try This Endpoint

Server URLs

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

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

Parameters

Path parameters

NameTypeRequiredDescription
environmentIdstring (uuid)YesEnvironment ID

Query parameters

NameTypeRequiredDescription
searchstringNoGet responses that match search param value
orderstringNoGet ordered responses
pagestringNoGet responses by page
pagesizestringNoGet responses by pagesize
filterstringNoNo description provided.

Returned Data

Responses

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

200
Environment connections

application/json

Schema: object

FieldTypeRequiredDescription
connectionsarray of objectNoNo description provided.
pageintegerNoNo description provided.
page_sizeintegerNoNo description provided.
total_countintegerNoNo description provided.
400
Invalid request body or request param

text/plain

Schema: string

Schema: string

401
Expired JWT token used or insufficient privilege

text/plain

Schema: string

Schema: string

500
Internal server error

text/plain

Schema: string

Schema: string

POST Connections

/api/environments/{environmentId}/connections/{connectionId}

Add connection to environment

Associate a connection with an environment

Try This Endpoint

Server URLs

Meshery Server default URL

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

Parameters

Path parameters

NameTypeRequiredDescription
environmentIdstring (uuid)YesEnvironment ID
connectionIdstring (uuid)YesConnection ID

Returned Data

Responses

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

200
Connection added to environment successfully
404
Connection or environment not found
500
Server error
DELETE Connections

/api/environments/{environmentId}/connections/{connectionId}

Remove connection from environment

Disassociate a connection from an environment

Try This Endpoint

Server URLs

Meshery Server default URL

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

Parameters

Path parameters

NameTypeRequiredDescription
environmentIdstring (uuid)YesEnvironment ID
connectionIdstring (uuid)YesConnection ID

Returned Data

Responses

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

204
Connection removed from environment successfully
404
Connection or environment not found
500
Server error
GET Organization

/api/identity/orgs

Read organizations

Returns organizations for the current user.
Authentication
Bearer JWT

Try This Endpoint

Server URLs

Meshery Server default URL

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

Parameters

Query parameters

NameTypeRequiredDescription
pagestringNoGet responses by page
pagesizestringNoGet responses by pagesize
searchstringNoGet responses that match search param value
orderstringNoGet ordered responses
allbooleanNoGet all possible entries

Returned Data

Responses

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

200
Organizations response

application/json

Schema: object

FieldTypeRequiredDescription
organizationsarray of objectNoNo description provided.
pageintegerNoNo description provided.
page_sizeintegerNoNo description provided.
total_countintegerNoNo description provided.
204
No content
401
Expired JWT token used or insufficient privilege

text/plain

Schema: string

Schema: string

500
Internal server error

text/plain

Schema: string

Schema: string

POST Organization

/api/identity/orgs

Create an organization

Creates a new organization.
Authentication
Bearer JWT

Try This Endpoint

Server URLs

Meshery Server default URL

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

Request body

Body for creating or updating an organization

application/json

Schema: object

Required
FieldTypeRequiredDescription
countrystringNoNo description provided.
descriptionstringNoNo description provided.
namestringNoNo description provided.
notify_org_updatebooleanNoNo description provided.
preferencesobjectNoNo description provided.
regionstringNoNo description provided.

Returned Data

Responses

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

201
Single-organization page response

application/json

Schema: object

Single-organization wrapper used by current meshery-cloud organization handlers.
FieldTypeRequiredDescription
organizationsarray of objectNoNo description provided.
pageintegerNoNo description provided.
page_sizeintegerNoNo description provided.
total_countintegerNoNo description provided.
401
Expired JWT token used or insufficient privilege

text/plain

Schema: string

Schema: string

500
Internal server error

text/plain

Schema: string

Schema: string

GET Organization

/api/identity/orgs/by-domain

Get organization by domain

Try This Endpoint

Server URLs

Meshery Server default URL

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

Parameters

Query parameters

NameTypeRequiredDescription
domainstringYesNo description provided.

Returned Data

Responses

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

200
Successful response

application/json

Schema: object

FieldTypeRequiredDescription
countrystringYesNo description provided.
created_atstring (date-time)YesNo description provided.
deleted_atstring (date-time)NoNo description provided.
descriptionstringYesNo description provided.
domainstring | nullNoNo description provided.
idstring (uuid)YesA Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
metadataobjectYesNo description provided.
namestringYesNo description provided.
ownerstring (uuid)YesA Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
regionstringYesNo description provided.
updated_atstring (date-time)YesNo description provided.
404
Organization not found
500
Internal server error
GET Organization

/api/identity/orgs/{orgId}

Read an organization

Returns the organization in the single-item page wrapper currently emitted by meshery-cloud.
Authentication
Bearer JWT

Try This Endpoint

Server URLs

Meshery Server default URL

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

Parameters

Path parameters

NameTypeRequiredDescription
orgIdstring (uuid)YesNo description provided.

Returned Data

Responses

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

200
Single-organization page response

application/json

Schema: object

Single-organization wrapper used by current meshery-cloud organization handlers.
FieldTypeRequiredDescription
organizationsarray of objectNoNo description provided.
pageintegerNoNo description provided.
page_sizeintegerNoNo description provided.
total_countintegerNoNo description provided.
401
Expired JWT token used or insufficient privilege

text/plain

Schema: string

Schema: string

500
Internal server error

text/plain

Schema: string

Schema: string

PUT Organization

/api/identity/orgs/{orgId}

Update an organization

Updates the organization.
Authentication
Bearer JWT

Try This Endpoint

Server URLs

Meshery Server default URL

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

Parameters

Path parameters

NameTypeRequiredDescription
orgIdstring (uuid)YesNo description provided.

Request body

Body for creating or updating an organization

application/json

Schema: object

Required
FieldTypeRequiredDescription
countrystringNoNo description provided.
descriptionstringNoNo description provided.
namestringNoNo description provided.
notify_org_updatebooleanNoNo description provided.
preferencesobjectNoNo description provided.
regionstringNoNo description provided.

Returned Data

Responses

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

200
Single-organization page response for the updated organization

application/json

Schema: object

Single-organization wrapper used by current meshery-cloud organization handlers.
FieldTypeRequiredDescription
organizationsarray of objectNoNo description provided.
pageintegerNoNo description provided.
page_sizeintegerNoNo description provided.
total_countintegerNoNo description provided.
400
Invalid request body or request param

text/plain

Schema: string

Schema: string

401
Expired JWT token used or insufficient privilege

text/plain

Schema: string

Schema: string

500
Internal server error

text/plain

Schema: string

Schema: string

DELETE Organization

/api/identity/orgs/{orgId}

Delete an organization

Deletes the organization.
Authentication
Bearer JWT

Try This Endpoint

Server URLs

Meshery Server default URL

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

Parameters

Path parameters

NameTypeRequiredDescription
orgIdstring (uuid)YesNo description provided.

Returned Data

Responses

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

200
Single-organization page response for the deleted organization

application/json

Schema: object

Single-organization wrapper used by current meshery-cloud organization handlers.
FieldTypeRequiredDescription
organizationsarray of objectNoNo description provided.
pageintegerNoNo description provided.
page_sizeintegerNoNo description provided.
total_countintegerNoNo description provided.
400
Invalid request body or request param

text/plain

Schema: string

Schema: string

401
Expired JWT token used or insufficient privilege

text/plain

Schema: string

Schema: string

404
Result not found

text/plain

Schema: string

Schema: string

500
Internal server error

text/plain

Schema: string

Schema: string

GET Organization

/api/identity/orgs/{orgId}/preferences

Get organization preferences

Returns preferences for the specified organization.
Authentication
Bearer JWT

Try This Endpoint

Server URLs

Meshery Server default URL

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

Parameters

Path parameters

NameTypeRequiredDescription
orgIdstring (uuid)YesNo description provided.

Returned Data

Responses

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

200
Organization metadata, including preferences

application/json

Schema: object

FieldTypeRequiredDescription
preferencesobjectYesNo description provided.
401
Expired JWT token used or insufficient privilege

text/plain

Schema: string

Schema: string

500
Internal server error

text/plain

Schema: string

Schema: string

GET Teams

/api/identity/orgs/{orgId}/teams

Get all teams for an organization

Gets all teams within an organization
Authentication
Bearer JWT

Try This Endpoint

Server URLs

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

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

Parameters

Path parameters

NameTypeRequiredDescription
orgIdstring (uuid)YesOrganization ID

Query parameters

NameTypeRequiredDescription
searchstringNoGet responses that match search param value
orderstringNoGet ordered responses
pagestringNoGet responses by page
pagesizestringNoGet responses by pagesize

Returned Data

Responses

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

200
Teams

application/json

Schema: object

Paginated list of teams
FieldTypeRequiredDescription
pageintegerNoNo description provided.
page_sizeintegerNoNo description provided.
teamsarray of objectNoNo description provided.
total_countintegerNoNo description provided.
401
Expired JWT token used or insufficient privilege

text/plain

Schema: string

Schema: string

500
Internal server error

text/plain

Schema: string

Schema: string

POST Teams

/api/identity/orgs/{orgId}/teams

Create a team

Creates a new team within an organization
Authentication
Bearer JWT

Try This Endpoint

Server URLs

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

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

Parameters

Path parameters

NameTypeRequiredDescription
orgIdstring (uuid)YesOrganization ID

Request body

Body for creating a team

application/json

Schema: object

Required
Payload for creating a new team
FieldTypeRequiredDescription
descriptionstringNoA detailed description of the team’s purpose and responsibilities.
namestringYesTeam name. Provide a meaningful name that represents this team.

Returned Data

Responses

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

201
Created team

application/json

Schema: object

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
FieldTypeRequiredDescription
idstring (uuid)YesTeam ID
namestringYesTeam name
descriptionstringNoTeam description
ownerstring (uuid)NoUser ID of the owner of the team
metadataobjectNoAdditional metadata for the team
created_atstring (date-time)NoNo description provided.
updated_atstring (date-time)NoNo description provided.
deleted_atstring (date-time)NoSQL null Timestamp to handle null values of time.
400
Invalid request body or request param

text/plain

Schema: string

Schema: string

500
Internal server error

text/plain

Schema: string

Schema: string

GET Teams

/api/identity/orgs/{orgId}/teams/{teamId}

Get a team by ID

Gets a team by its ID
Authentication
Bearer JWT

Try This Endpoint

Server URLs

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

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

Parameters

Path parameters

NameTypeRequiredDescription
orgIdstring (uuid)YesOrganization ID
teamIdstring (uuid)YesTeam ID

Returned Data

Responses

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

200
Team

application/json

Schema: object

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
FieldTypeRequiredDescription
idstring (uuid)YesTeam ID
namestringYesTeam name
descriptionstringNoTeam description
ownerstring (uuid)NoUser ID of the owner of the team
metadataobjectNoAdditional metadata for the team
created_atstring (date-time)NoNo description provided.
updated_atstring (date-time)NoNo description provided.
deleted_atstring (date-time)NoSQL null Timestamp to handle null values of time.
400
Invalid request body or request param

text/plain

Schema: string

Schema: string

401
Expired JWT token used or insufficient privilege

text/plain

Schema: string

Schema: string

404
Result not found

text/plain

Schema: string

Schema: string

500
Internal server error

text/plain

Schema: string

Schema: string

POST Organization

/api/identity/orgs/{orgId}/teams/{teamId}

Add team to organization or soft delete team

Adds a team to an organization. If request body contains action=delete, tombstones a team by setting its deleted_at timestamp. The team’s organization mapping remains intact.
Authentication
Bearer JWT

Try This Endpoint

Server URLs

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

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

Parameters

Path parameters

NameTypeRequiredDescription
orgIdstring (uuid)YesNo description provided.
teamIdstring (uuid)YesNo description provided.

Request body

application/json

Schema: object

Optional
Optional action payload for POST on /api/identity/orgs/{orgId}/teams/{teamId}.
FieldTypeRequiredDescription
actionstringNoInternal action to perform on the team resource.

Returned Data

Responses

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

200
Team added to organization or team tombstoned

application/json

Schema: one of object

object

FieldTypeRequiredDescription
pageintegerNoNo description provided.
page_sizeintegerNoNo description provided.
teams_organizations_mappingarray of objectNoNo description provided.
total_countintegerNoNo description provided.

object

FieldTypeRequiredDescription
pageintegerNoNo description provided.
page_sizeintegerNoNo description provided.
teamsarray of objectNoNo description provided.
total_countintegerNoNo description provided.
400
Bad request
401
Unauthorized
404
Not found
500
Internal server error
PUT Teams

/api/identity/orgs/{orgId}/teams/{teamId}

Update a team

Updates a team’s information
Authentication
Bearer JWT

Try This Endpoint

Server URLs

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

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

Parameters

Path parameters

NameTypeRequiredDescription
orgIdstring (uuid)YesOrganization ID
teamIdstring (uuid)YesTeam ID

Request body

Body for updating a team

application/json

Schema: object

Required
Payload for updating an existing team
FieldTypeRequiredDescription
descriptionstringNoUpdated team description
namestringNoUpdated team name

Returned Data

Responses

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

200
Updated team

application/json

Schema: object

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
FieldTypeRequiredDescription
idstring (uuid)YesTeam ID
namestringYesTeam name
descriptionstringNoTeam description
ownerstring (uuid)NoUser ID of the owner of the team
metadataobjectNoAdditional metadata for the team
created_atstring (date-time)NoNo description provided.
updated_atstring (date-time)NoNo description provided.
deleted_atstring (date-time)NoSQL null Timestamp to handle null values of time.
400
Invalid request body or request param

text/plain

Schema: string

Schema: string

401
Expired JWT token used or insufficient privilege

text/plain

Schema: string

Schema: string

404
Result not found

text/plain

Schema: string

Schema: string

500
Internal server error

text/plain

Schema: string

Schema: string

DELETE Teams

/api/identity/orgs/{orgId}/teams/{teamId}

Delete a team

Deletes a team by its ID
Authentication
Bearer JWT

Try This Endpoint

Server URLs

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

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

Parameters

Path parameters

NameTypeRequiredDescription
orgIdstring (uuid)YesOrganization ID
teamIdstring (uuid)YesTeam ID

Returned Data

Responses

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

204
Team deleted successfully
400
Invalid request body or request param

text/plain

Schema: string

Schema: string

401
Expired JWT token used or insufficient privilege

text/plain

Schema: string

Schema: string

404
Result not found

text/plain

Schema: string

Schema: string

500
Internal server error

text/plain

Schema: string

Schema: string

POST Organization

/api/identity/orgs/{orgId}/teams/{teamId}/remove

Remove team from organization

Removes (unassigns) a team from an organization.
Authentication
Bearer JWT

Try This Endpoint

Server URLs

Meshery Server default URL

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

Parameters

Path parameters

NameTypeRequiredDescription
orgIdstring (uuid)YesNo description provided.
teamIdstring (uuid)YesNo description provided.

Returned Data

Responses

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

200
Team removed from organization

application/json

Schema: object

FieldTypeRequiredDescription
pageintegerNoNo description provided.
page_sizeintegerNoNo description provided.
teams_organizations_mappingarray of objectNoNo description provided.
total_countintegerNoNo description provided.
400
Bad request
401
Unauthorized
404
Not found
500
Internal server error
GET Teams

/api/identity/orgs/{orgId}/teams/{teamId}/users

Get users that are not in a team

Authentication
Bearer JWT

Try This Endpoint

Server URLs

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

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

Parameters

Path parameters

NameTypeRequiredDescription
orgIdstring (uuid)YesOrganization ID
teamIdstring (uuid)YesTeam ID

Query parameters

NameTypeRequiredDescription
searchstringNoGet responses that match search param value
orderstringNoGet ordered responses
pagestringNoGet responses by page
pagesizestringNoGet responses by pagesize

Returned Data

Responses

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

200
Users not currently in the team

application/json

Schema: object

FieldTypeRequiredDescription
dataarray of objectNoNo description provided.
pageintegerNoNo description provided.
page_sizeintegerNoNo description provided.
total_countintegerNoNo description provided.
400
Invalid request body or request param

text/plain

Schema: string

Schema: string

401
Expired JWT token used or insufficient privilege

text/plain

Schema: string

Schema: string

500
Internal server error

text/plain

Schema: string

Schema: string

POST Teams

/api/identity/orgs/{orgId}/teams/{teamId}/users/{userId}

Add a user to a team

Assigns a user to a team
Authentication
Bearer JWT

Try This Endpoint

Server URLs

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

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

Parameters

Path parameters

NameTypeRequiredDescription
orgIdstring (uuid)YesOrganization ID
teamIdstring (uuid)YesTeam ID
userIdstringYesUser ID

Returned Data

Responses

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

200
User added to team

application/json

Schema: object

Mapping between teams and users
FieldTypeRequiredDescription
created_atstring (date-time)NoTimestamp when the resource was created.
deleted_atstring (date-time)NoSQL null Timestamp to handle null values of time.
idstring (uuid)NoNo description provided.
team_idstring (uuid)NoNo description provided.
updated_atstring (date-time)NoTimestamp when the resource was updated.
user_idstringNouser’s email or username
400
Invalid request body or request param

text/plain

Schema: string

Schema: string

401
Expired JWT token used or insufficient privilege

text/plain

Schema: string

Schema: string

500
Internal server error

text/plain

Schema: string

Schema: string

DELETE Teams

/api/identity/orgs/{orgId}/teams/{teamId}/users/{userId}

Remove a user from a team

Unassigns a user from a team
Authentication
Bearer JWT

Try This Endpoint

Server URLs

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

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

Parameters

Path parameters

NameTypeRequiredDescription
orgIdstring (uuid)YesOrganization ID
teamIdstring (uuid)YesTeam ID
userIdstringYesUser ID

Returned Data

Responses

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

200
User removed from team

application/json

Schema: object

Mapping between teams and users
FieldTypeRequiredDescription
created_atstring (date-time)NoTimestamp when the resource was created.
deleted_atstring (date-time)NoSQL null Timestamp to handle null values of time.
idstring (uuid)NoNo description provided.
team_idstring (uuid)NoNo description provided.
updated_atstring (date-time)NoTimestamp when the resource was updated.
user_idstringNouser’s email or username
400
Invalid request body or request param

text/plain

Schema: string

Schema: string

401
Expired JWT token used or insufficient privilege

text/plain

Schema: string

Schema: string

404
Result not found

text/plain

Schema: string

Schema: string

500
Internal server error

text/plain

Schema: string

Schema: string

GET Users

/api/identity/orgs/{orgId}/users

Get organization users

Returns organization users, optionally filtered by team membership.

Try This Endpoint

Server URLs

Meshery Server default URL

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

Parameters

Path parameters

NameTypeRequiredDescription
orgIdstring (uuid)YesOrganization ID

Query parameters

NameTypeRequiredDescription
pagestringNoGet responses by page
pagesizestringNoGet responses by pagesize
searchstringNoGet responses that match search param value
orderstringNoGet ordered responses
filterstringNoGet filtered reponses
teamIDstring (uuid)NoOptional team filter when listing organization users

Returned Data

Responses

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

200
Paginated list of organization users

application/json

Schema: object

Paginated list of users with organization and team role context
FieldTypeRequiredDescription
dataarray of objectNoNo description provided.
pageintegerNoNo description provided.
page_sizeintegerNoNo description provided.
total_countintegerNoNo description provided.
400
Invalid request body or request param

text/plain

Schema: string

Schema: string

401
Expired JWT token used or insufficient privilege

text/plain

Schema: string

Schema: string

500
Internal server error

text/plain

Schema: string

Schema: string

POST Users

/api/identity/orgs/{orgId}/users/bulk

Bulk delete organization users

Try This Endpoint

Server URLs

Meshery Server default URL

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

Parameters

Path parameters

NameTypeRequiredDescription
orgIdstring (uuid)YesOrganization ID

Request body

application/json

Schema: object

Required

Schema: object

Returned Data

Responses

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

201
Users deleted

application/json

Schema: object

Schema: object

400
Invalid request body or request param

text/plain

Schema: string

Schema: string

401
Expired JWT token used or insufficient privilege

text/plain

Schema: string

Schema: string

500
Internal server error

text/plain

Schema: string

Schema: string

GET Key

/api/identity/orgs/{orgId}/users/keys

Get User Keys

Get all keys based on roles assigned to user
Authentication
Bearer JWT

Try This Endpoint

Server URLs

Meshery Server default URL

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

Parameters

Path parameters

NameTypeRequiredDescription
orgIdstring (uuid)YesOrganization ID

Returned Data

Responses

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

200
Returns user keys based on roles assigned to user

application/json

Schema: object

FieldTypeRequiredDescription
pageintegerYesNo description provided.
page_sizeintegerYesNo description provided.
total_countintegerYesNo description provided.
keysarray of objectYesNo description provided.
401
Expired JWT token used or insufficient privilege

text/plain

Schema: string

Schema: string

500
Internal server error

text/plain

Schema: string

Schema: string

POST Organization

/api/identity/orgs/{orgId}/users/{userId}

Add user to organization

Authentication
Bearer JWT

Try This Endpoint

Server URLs

Meshery Server default URL

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

Parameters

Path parameters

NameTypeRequiredDescription
orgIdstring (uuid)YesNo description provided.
userIdstringYesNo description provided.

Returned Data

Responses

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

200
User added to organization

application/json

Schema: object

Schema: object

401
Unauthorized
500
Internal server error
DELETE Organization

/api/identity/orgs/{orgId}/users/{userId}

Remove user from organization

Authentication
Bearer JWT

Try This Endpoint

Server URLs

Meshery Server default URL

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

Parameters

Path parameters

NameTypeRequiredDescription
orgIdstring (uuid)YesNo description provided.
userIdstringYesNo description provided.

Returned Data

Responses

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

200
User removed from organization

application/json

Schema: object

Schema: object

401
Unauthorized
500
Internal server error
GET Teams

/api/identity/teams/{teamId}/users

Get all users in a team

Gets all users that belong to a team
Authentication
Bearer JWT

Try This Endpoint

Server URLs

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

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

Parameters

Path parameters

NameTypeRequiredDescription
teamIdstring (uuid)YesTeam ID

Query parameters

NameTypeRequiredDescription
searchstringNoGet responses that match search param value
orderstringNoGet ordered responses
pagestringNoGet responses by page
pagesizestringNoGet responses by pagesize

Returned Data

Responses

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

200
Team users mapping

application/json

Schema: object

Paginated list of team-user mappings
FieldTypeRequiredDescription
pageintegerNoNo description provided.
page_sizeintegerNoNo description provided.
teams_users_mappingarray of objectNoNo description provided.
total_countintegerNoNo description provided.
400
Invalid request body or request param

text/plain

Schema: string

Schema: string

401
Expired JWT token used or insufficient privilege

text/plain

Schema: string

Schema: string

500
Internal server error

text/plain

Schema: string

Schema: string

GET Users

/api/identity/users/notifications/preferences

Get available notification preferences

Try This Endpoint

Server URLs

Meshery Server default URL

http://localhost:9081/api/identity/users/notifications/preferences

Returned Data

Responses

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

200
Available notification preferences

application/json

Schema: object

FieldTypeRequiredDescription
notification_preferencesobjectNoNo description provided.
401
Expired JWT token used or insufficient privilege

text/plain

Schema: string

Schema: string

500
Internal server error

text/plain

Schema: string

Schema: string

PUT Users

/api/identity/users/notifications/preferences

Update notification preferences

Try This Endpoint

Server URLs

Meshery Server default URL

http://localhost:9081/api/identity/users/notifications/preferences

Request body

application/json

Schema: object

Required

Schema: object

Returned Data

Responses

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

200
Notification preferences updated

application/json

Schema: object

Schema: object

400
Invalid request body or request param

text/plain

Schema: string

Schema: string

500
Internal server error

text/plain

Schema: string

Schema: string

POST Users

/api/identity/users/notify/feedback

Submit feedback notification

Try This Endpoint

Server URLs

Meshery Server default URL

http://localhost:9081/api/identity/users/notify/feedback

Request body

application/json

Schema: object

Required

Schema: object

Returned Data

Responses

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

201
Feedback submitted

application/json

Schema: object

Schema: object

400
Invalid request body or request param

text/plain

Schema: string

Schema: string

401
Expired JWT token used or insufficient privilege

text/plain

Schema: string

Schema: string

500
Internal server error

text/plain

Schema: string

Schema: string

POST Users

/api/identity/users/password

Update current user password

Try This Endpoint

Server URLs

Meshery Server default URL

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

Request body

application/json

Schema: object

Required
FieldTypeRequiredDescription
passwordstringNoNo description provided.

Returned Data

Responses

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

200
Password updated

application/json

Schema: object

Schema: object

401
Expired JWT token used or insufficient privilege

text/plain

Schema: string

Schema: string

500
Internal server error

text/plain

Schema: string

Schema: string

PUT Users

/api/identity/users/preferences

Update user preferences

Try This Endpoint

Server URLs

Meshery Server default URL

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

Request body

application/json

Schema: object

Required

Schema: object

Returned Data

Responses

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

201
Preferences updated

application/json

Schema: object

Schema: object

401
Expired JWT token used or insufficient privilege

text/plain

Schema: string

Schema: string

500
Internal server error

text/plain

Schema: string

Schema: string

GET Users

/api/identity/users/profile

Get current user profile

Try This Endpoint

Server URLs

Meshery Server default URL

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

Returned Data

Responses

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

200
Current user profile and role context

application/json

Schema: object

Represents a user in Layer5 Cloud (Meshery)
FieldTypeRequiredDescription
accepted_terms_atstring (date-time)NoTimestamp when user accepted terms and conditions
avatar_urlstring (uri)NoURL to user’s avatar image
biostringNoUser’s biography or description
countryobjectNoUser’s country information stored as JSONB
created_atstring (date-time)YesTimestamp when the user record was created
deleted_atstring | null (date-time)YesTimestamp when the user record was soft-deleted (null if not deleted)
emailstring (email)YesUser’s email address
first_login_timestring (date-time)NoTimestamp of user’s first login
first_namestringYesUser’s first name
idstring (uuid)YesUnique identifier for the user
last_login_timestring (date-time)YesTimestamp of user’s most recent login
last_namestringYesUser’s last name
organizationsobjectNoOrganizations the user belongs to with role information
preferencesobjectNoUser preferences stored as JSONB
providerstringYesAuthentication provider (e.g., Layer5 Cloud, Twitter, Facebook, Github)
regionobjectNoUser’s region information stored as JSONB
role_namesarray of stringNoList of global roles assigned to the user
socialsarray of objectNoVarious online profiles associated with the user account
statusstringYesUser account status
teamsobjectNoTeams the user belongs to with role information
updated_atstring (date-time)YesTimestamp when the user record was last updated
user_idstringYesUser identifier (username or external ID)
401
Expired JWT token used or insufficient privilege

text/plain

Schema: string

Schema: string

500
Internal server error

text/plain

Schema: string

Schema: string

GET Users

/api/identity/users/profile/details

Get current user profile overview

Try This Endpoint

Server URLs

Meshery Server default URL

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

Returned Data

Responses

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

200
User account overview

application/json

Schema: object

Schema: object

401
Expired JWT token used or insufficient privilege

text/plain

Schema: string

Schema: string

500
Internal server error

text/plain

Schema: string

Schema: string

GET Users

/api/identity/users/profile/{id}

Get user profile by ID

Try This Endpoint

Server URLs

Meshery Server default URL

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

Parameters

Path parameters

NameTypeRequiredDescription
idstring (uuid)YesUser ID

Returned Data

Responses

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

200
User profile for the requested ID

application/json

Schema: object

Represents a user in Layer5 Cloud (Meshery)
FieldTypeRequiredDescription
accepted_terms_atstring (date-time)NoTimestamp when user accepted terms and conditions
avatar_urlstring (uri)NoURL to user’s avatar image
biostringNoUser’s biography or description
countryobjectNoUser’s country information stored as JSONB
created_atstring (date-time)YesTimestamp when the user record was created
deleted_atstring | null (date-time)YesTimestamp when the user record was soft-deleted (null if not deleted)
emailstring (email)YesUser’s email address
first_login_timestring (date-time)NoTimestamp of user’s first login
first_namestringYesUser’s first name
idstring (uuid)YesUnique identifier for the user
last_login_timestring (date-time)YesTimestamp of user’s most recent login
last_namestringYesUser’s last name
organizationsobjectNoOrganizations the user belongs to with role information
preferencesobjectNoUser preferences stored as JSONB
providerstringYesAuthentication provider (e.g., Layer5 Cloud, Twitter, Facebook, Github)
regionobjectNoUser’s region information stored as JSONB
role_namesarray of stringNoList of global roles assigned to the user
socialsarray of objectNoVarious online profiles associated with the user account
statusstringYesUser account status
teamsobjectNoTeams the user belongs to with role information
updated_atstring (date-time)YesTimestamp when the user record was last updated
user_idstringYesUser identifier (username or external ID)
400
Invalid request body or request param

text/plain

Schema: string

Schema: string

500
Internal server error

text/plain

Schema: string

Schema: string

DELETE Users

/api/identity/users/self

Delete current user account

Try This Endpoint

Server URLs

Meshery Server default URL

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

Returned Data

Responses

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

201
Account deleted

application/json

Schema: object

Schema: object

400
Invalid request body or request param

text/plain

Schema: string

Schema: string

401
Expired JWT token used or insufficient privilege

text/plain

Schema: string

Schema: string

500
Internal server error

text/plain

Schema: string

Schema: string

GET Users

/api/identity/users/{userId}/profile/activity

Get user activity

Authentication
No authentication required

Try This Endpoint

Server URLs

Meshery Server default URL

http://localhost:9081/api/identity/users/{userId}/profile/activity

Parameters

Path parameters

NameTypeRequiredDescription
userIdstring (uuid)YesUser ID

Query parameters

NameTypeRequiredDescription
pagestringNoGet responses by page
pagesizestringNoGet responses by pagesize
orderstringNoGet ordered responses
filterstringNoGet filtered reponses

Returned Data

Responses

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

200
User recent activity

application/json

Schema: object

FieldTypeRequiredDescription
dataarray of objectNoNo description provided.
pageintegerNoNo description provided.
page_sizeintegerNoNo description provided.
total_countintegerNoNo description provided.
500
Internal server error

text/plain

Schema: string

Schema: string

GET Connections

/api/integrations/connections

Get all connections

Returns a paginated list of connections for the authenticated user with filtering, sorting and pagination support

Try This Endpoint

Server URLs

Meshery Server default URL

http://localhost:9081/api/integrations/connections

Parameters

Query parameters

NameTypeRequiredDescription
pageintegerNoPage number
pagesizeintegerNoNumber of items per page
searchstringNoSearch term
orderstringNoSort order
filterstringNoFilter connections (general filter string)
kindarray of stringNoFilter by connection kind (e.g., kubernetes, prometheus, grafana)
statusarray of stringNoFilter by connection status
typearray of stringNoFilter by connection type
namestringNoFilter by connection name (partial match supported)

Returned Data

Responses

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

200
Paginated list of connections with summary information

application/json

Schema: object

Represents a page of connections with meta information about connections count
FieldTypeRequiredDescription
connectionsarray of objectYesList of connections on this page
total_countintegerYesTotal number of connections on all pages
pageintegerYesCurrent page number
page_sizeintegerYesNumber of elements per page
status_summaryobjectNoAggregate count of connections grouped by status
500
Server error
POST Connections

/api/integrations/connections

Register a new connection

Register a new connection with credentials

Try This Endpoint

Server URLs

Meshery Server default URL

http://localhost:9081/api/integrations/connections

Request body

application/json

Schema: object

Required
Payload for creating or updating a connection
FieldTypeRequiredDescription
credential_idstring (uuid)NoAssociated credential ID
credential_secretobjectNoCredential secret data
idstring (uuid)NoConnection ID
kindstringYesConnection kind
metadataobjectNoConnection metadata
namestringYesConnection name
statusstringYesConnection status
sub_typestringYesConnection sub-type
typestringYesConnection type

Returned Data

Responses

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

201
Connection registered successfully

application/json

Schema: object

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
FieldTypeRequiredDescription
idstring (uuid)YesConnection ID
namestringYesConnection Name
credential_idstring (uuid)NoAssociated Credential ID
typestringYesConnection Type (platform, telemetry, collaboration)
sub_typestringYesConnection Subtype (cloud, identity, metrics, chat, git, orchestration)
kindstringYesConnection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github)
metadataobjectNoAdditional connection metadata
statusstringYesConnection Status
user_idstring (uuid)NoUser ID who owns this connection
created_atstring (date-time)NoNo description provided.
updated_atstring (date-time)NoNo description provided.
deleted_atstring (date-time)NoSQL null Timestamp to handle null values of time.
environmentsarray of objectNoAssociated environments for this connection
schemaVersionstringYesSpecifies the version of the schema used for the definition.
400
Invalid request parameters
500
Server error
GET Connections

/api/integrations/connections/kubernetes/{connectionId}/context

Get Kubernetes context

Get Kubernetes context for a specific connection

Try This Endpoint

Server URLs

Meshery Server default URL

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

Parameters

Path parameters

NameTypeRequiredDescription
connectionIdstring (uuid)YesConnection ID

Returned Data

Responses

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

200
Kubernetes context

application/json

Schema: object

Schema: object

404
Connection not found
500
Server error
DELETE Connections

/api/integrations/connections/meshery/{mesheryServerId}

Delete Meshery instance connection

Delete a Meshery server connection by server ID

Try This Endpoint

Server URLs

Meshery Server default URL

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

Parameters

Path parameters

NameTypeRequiredDescription
mesheryServerIdstring (uuid)YesMeshery server ID

Returned Data

Responses

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

204
Meshery connection deleted successfully
404
Connection not found
500
Server error
GET Connections

/api/integrations/connections/{connectionId}

Get connection by ID

Returns a specific connection by its ID

Try This Endpoint

Server URLs

Meshery Server default URL

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

Parameters

Path parameters

NameTypeRequiredDescription
connectionIdstring (uuid)YesConnection ID

Returned Data

Responses

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

200
Connection details

application/json

Schema: object

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
FieldTypeRequiredDescription
idstring (uuid)YesConnection ID
namestringYesConnection Name
credential_idstring (uuid)NoAssociated Credential ID
typestringYesConnection Type (platform, telemetry, collaboration)
sub_typestringYesConnection Subtype (cloud, identity, metrics, chat, git, orchestration)
kindstringYesConnection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github)
metadataobjectNoAdditional connection metadata
statusstringYesConnection Status
user_idstring (uuid)NoUser ID who owns this connection
created_atstring (date-time)NoNo description provided.
updated_atstring (date-time)NoNo description provided.
deleted_atstring (date-time)NoSQL null Timestamp to handle null values of time.
environmentsarray of objectNoAssociated environments for this connection
schemaVersionstringYesSpecifies the version of the schema used for the definition.
404
Connection not found
500
Server error
PUT Connections

/api/integrations/connections/{connectionId}

Update a connection

Update an existing connection

Try This Endpoint

Server URLs

Meshery Server default URL

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

Parameters

Path parameters

NameTypeRequiredDescription
connectionIdstring (uuid)YesConnection ID

Request body

application/json

Schema: object

Required
Payload for creating or updating a connection
FieldTypeRequiredDescription
credential_idstring (uuid)NoAssociated credential ID
credential_secretobjectNoCredential secret data
idstring (uuid)NoConnection ID
kindstringYesConnection kind
metadataobjectNoConnection metadata
namestringYesConnection name
statusstringYesConnection status
sub_typestringYesConnection sub-type
typestringYesConnection type

Returned Data

Responses

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

200
Connection updated successfully

application/json

Schema: object

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
FieldTypeRequiredDescription
idstring (uuid)YesConnection ID
namestringYesConnection Name
credential_idstring (uuid)NoAssociated Credential ID
typestringYesConnection Type (platform, telemetry, collaboration)
sub_typestringYesConnection Subtype (cloud, identity, metrics, chat, git, orchestration)
kindstringYesConnection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github)
metadataobjectNoAdditional connection metadata
statusstringYesConnection Status
user_idstring (uuid)NoUser ID who owns this connection
created_atstring (date-time)NoNo description provided.
updated_atstring (date-time)NoNo description provided.
deleted_atstring (date-time)NoSQL null Timestamp to handle null values of time.
environmentsarray of objectNoAssociated environments for this connection
schemaVersionstringYesSpecifies the version of the schema used for the definition.
404
Connection not found
500
Server error
DELETE Connections

/api/integrations/connections/{connectionId}

Delete a connection

Delete a specific connection

Try This Endpoint

Server URLs

Meshery Server default URL

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

Parameters

Path parameters

NameTypeRequiredDescription
connectionIdstring (uuid)YesConnection ID

Returned Data

Responses

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

204
Connection deleted successfully
404
Connection not found
500
Server error
POST Model

/api/meshmodels/register

Register mesh models

Try This Endpoint

Server URLs

Meshery Server default URL

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

Request body

multipart/form-data

Schema: object

Required
FieldTypeRequiredDescription
importBodyone of File Import, URL Import, CSV Import, Model CreateYesNo description provided.
registerbooleanYesNo description provided.
uploadTypestringYesChoose 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.

200
Successful registration

application/json

Schema: object

FieldTypeRequiredDescription
messagestringNoNo description provided.
400
Invalid request format
500
Internal server error
POST Design

/api/pattern/import

Import Design

Try This Endpoint

Server URLs

Meshery Server default URL

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

Request body

multipart/form-data

Schema: object

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.
FieldTypeRequiredDescription
filestring (file)NoSupported formats: Kubernetes Manifests, Helm Charts, Docker Compose, and Meshery Designs. See Import Designs Documentation for details
file_namestringNoThe name of the pattern file being imported.
namestringNoProvide 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.
urlstring (uri)NoProvide 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.

200
Successful Import

application/json

Schema: object

FieldTypeRequiredDescription
messagestringNoNo description provided.
400
Invalid request format
500
Internal server error
GET Users

/api/users

Get public users

Returns publicly viewable user records.

Try This Endpoint

Server URLs

Meshery Server default URL

http://localhost:9081/api/users

Parameters

Query parameters

NameTypeRequiredDescription
pagestringNoGet responses by page
pagesizestringNoGet responses by pagesize
searchstringNoGet responses that match search param value
orderstringNoGet ordered responses
filterstringNoGet filtered reponses

Returned Data

Responses

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

200
Paginated list of public users

application/json

Schema: object

Paginated list of public user records
FieldTypeRequiredDescription
dataarray of objectNoNo description provided.
pageintegerNoNo description provided.
page_sizeintegerNoNo description provided.
total_countintegerNoNo description provided.
400
Invalid request body or request param

text/plain

Schema: string

Schema: string

401
Expired JWT token used or insufficient privilege

text/plain

Schema: string

Schema: string

500
Internal server error

text/plain

Schema: string

Schema: string

POST Evaluation

/evaluate

Evaluate relationships in a design

Performs relationship evaluation on a given design, applying policies and updating components and relationships as needed.

Try This Endpoint

Server URLs

Meshery Server default URL

http://localhost:9081/evaluate

Request body

application/json

Schema: object

Required
FieldTypeRequiredDescription
designobjectYesDesigns are your primary tool for collaborative authorship of your infrastructure, workflow, and processes.
optionsobjectNoNo description provided.

Returned Data

Responses

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

200
Successful evaluation

application/json

Schema: object

Schema for the response of a relationship evaluation process in Meshery
FieldTypeRequiredDescription
actionsarrayYesNo description provided.
designobjectYesThe 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.
evaluationHashstringNoHash of the input parameters and configuration used for this evaluation. Useful for identifying duplicate evaluations or caching results.
schemaVersionstringYesSpecifies the version of the schema to which the evaluation response conforms.
timestampstring (date-time)NoISO 8601 formatted timestamp of when the evaluation was completed.
400
Bad request
500
Internal server error
POST Events

/events

Create a new event

Try This Endpoint

Server URLs

Meshery Server default URL

http://localhost:9081/events

Request body

application/json

Schema: object

Required

Schema: object

Returned Data

Responses

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

200
Event created successfully
400
Invalid request

application/json

Schema: object

FieldTypeRequiredDescription
errorstringNoNo description provided.
500
Server error
POST Events

/events/delete

Bulk delete events

Try This Endpoint

Server URLs

Meshery Server default URL

http://localhost:9081/events/delete

Request body

application/json

Schema: object

Required
FieldTypeRequiredDescription
idsarray of string (uuid)YesNo description provided.

Returned Data

Responses

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

200
event deleted

application/json

Schema: object

FieldTypeRequiredDescription
deletedarray of string (uuid)NoNo description provided.
400
Invalid request

application/json

Schema: object

FieldTypeRequiredDescription
errorstringNoNo description provided.
500
Server error
PUT Events

/events/status

Bulk update event status

Try This Endpoint

Server URLs

Meshery Server default URL

http://localhost:9081/events/status

Request body

application/json

Schema: object

Required
FieldTypeRequiredDescription
idsarray of string (uuid)YesNo description provided.
statusstringYesNo description provided.

Returned Data

Responses

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

200
Events updated successfully

application/json

Schema: object

FieldTypeRequiredDescription
updatedarray of string (uuid)NoNo description provided.
400
Invalid request

application/json

Schema: object

FieldTypeRequiredDescription
errorstringNoNo description provided.
500
Server error
DELETE Events

/events/{id}

Delete a single event

Try This Endpoint

Server URLs

Meshery Server default URL

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

Parameters

Path parameters

NameTypeRequiredDescription
idstring (uuid)YesID of the event to delete

Returned Data

Responses

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

200
Event deleted successfully

application/json

Schema: object

FieldTypeRequiredDescription
event_idstring (uuid)NoNo description provided.
messagestringNoNo description provided.
400
Invalid event ID

application/json

Schema: object

FieldTypeRequiredDescription
errorstringNoNo description provided.
500
Server error
PUT Events

/events/{id}/status

Update status of a single event

Try This Endpoint

Server URLs

Meshery Server default URL

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

Parameters

Path parameters

NameTypeRequiredDescription
idstring (uuid)YesID of the event

Request body

application/json

Schema: object

Required
FieldTypeRequiredDescription
statusstringYesNo description provided.

Returned Data

Responses

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

200
Event status updated successfully

application/json

Schema: object

FieldTypeRequiredDescription
event_idstring (uuid)NoNo description provided.
messagestringNoNo description provided.
statusstringNoNo description provided.
400
Invalid request or status

application/json

Schema: object

FieldTypeRequiredDescription
errorstringNoNo description provided.
500
Server error