Select an endpoint
Open a category, choose a tag, and pick an endpoint to view its request and response details here.
To create integrations, retrieve data, and automate your cloud native infrastructure, build with the Layer5 Cloud REST API.
In order to authenticate to Layer5 Cloud’s REST API, you need to generate and use a security token. Visit your user account’s security tokens and generate a long-lived token. Security tokens remain valid until you revoke them, and you can issue as many as you need.
To authenticate with the API, pass the token as a bearer token in the Authorization header. For example, in cURL:
curl <protocol>://<Layer5-cloud-hostname>/api/identity/users/profile \
-H "Authorization: Bearer <token>"
<protocol> with http or https depending on your Layer5 Cloud instance.<Layer5-cloud-hostname> with the hostname or IP address of your hosted Layer5 Cloud instance. For example, https://cloud.layer5.io.<token> with the security token you generated.Layer5 Cloud API tokens are scoped to your user account, not to a specific organization. This means a single API token provides access to all organizations you are a member of. For users who belong to multiple organizations, you need to explicitly specify which organization your API requests should operate on.
This is similar to how GitHub Personal Access Tokens work, where a single token grants access to all repositories and organizations the user has access to.
There are two ways to control the organization context for your API requests:
layer5-current-orgid Header
πInclude the layer5-current-orgid header with your organization’s ID to specify the target organization for a request:
curl -X GET "https://cloud.layer5.io/api/environments" \
-H "Authorization: Bearer <Your-Token>" \
-H "layer5-current-orgid: <Your-Organization-ID>"const token = "Your-Token";
const orgId = "Your-Organization-ID";
async function listEnvironments() {
const res = await fetch("https://cloud.layer5.io/api/environments", {
method: "GET",
headers: {
Authorization: `Bearer ${token}`,
"layer5-current-orgid": orgId,
},
});
const data = await res.json();
console.log(data);
}
listEnvironments();import requests
url = "https://cloud.layer5.io/api/environments"
headers = {
"Authorization": "Bearer <Your-Token>",
"layer5-current-orgid": "<Your-Organization-ID>"
}
res = requests.get(url, headers=headers)
print(res.json())Alternatively, you can set your default organization and workspace using the Preferences API. This sets your user preferences so that subsequent API requests will use the specified organization and workspace context:
# Set organization and workspace preferences
curl -X PUT "https://cloud.layer5.io/api/identity/users/preferences" \
-H "Authorization: Bearer <Your-Token>" \
-H "Content-Type: application/json" \
-d '{
"selectedOrganization": "<Your-Organization-ID>",
"selectedWorkspace": "<Your-Workspace-ID>"
}'const token = "Your-Token";
async function setPreferences() {
const res = await fetch("https://cloud.layer5.io/api/identity/users/preferences", {
method: "PUT",
headers: {
Authorization: `Bearer ${token}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
selectedOrganization: "<Your-Organization-ID>",
selectedWorkspace: "<Your-Workspace-ID>",
}),
});
const data = await res.json();
console.log(data);
}
setPreferences();import requests
import json
url = "https://cloud.layer5.io/api/identity/users/preferences"
headers = {
"Authorization": "Bearer <Your-Token>",
"Content-Type": "application/json"
}
payload = {
"selectedOrganization": "<Your-Organization-ID>",
"selectedWorkspace": "<Your-Workspace-ID>"
}
res = requests.put(url, headers=headers, data=json.dumps(payload))
print(res.json())The following example demonstrate how to retrieve information from the Academy REST APIs.
Use the Layer5 Cloud API to retrieve the total number of registered learners. Pass your Security Token as a Bearer token in the Authorization header (as shown in Authenticating with API). The response JSON includes an array of user objects.
curl -s -X GET "https://cloud.layer5.io/api/academy/cirricula" \
-H "Authorization: Bearer <Your-Token>" \
| jq '[.data[].registration_count] | add'const token = "Your-Token"
async function getTotalLearners() {
const res = await fetch("https://cloud.layer5.io/api/academy/cirricula", {
headers: { Authorization: `Bearer ${token}` },
});
const data = await res.json();
const total = data.data.reduce((sum, path) => sum + path.registration_count, 0);
console.log(total);
}
getTotalLearners();import requests
url = "https://cloud.layer5.io/api/academy/cirricula"
headers = {"Authorization": "Bearer <Your-Token>"}
res = requests.get(url, headers=headers)
data = res.json()
total = sum(item["registration_count"] for item in data["data"])
print(total)package main
import (
"encoding/json"
"fmt"
"io"
"net/http"
)
type Path struct {
RegistrationCount int `json:"registration_count"`
}
type Response struct {
Data []Path `json:"data"`
}
func main() {
url := "https://cloud.layer5.io/api/academy/cirricula"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Set("Authorization", "Bearer <your-token>")
client := &http.Client{}
res, err := client.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
var response Response
if err := json.Unmarshal(body, &response); err != nil {
panic(err)
}
total := 0
for _, path := range response.Data {
total += path.RegistrationCount
}
fmt.Println(total)
}This returns the number of Total registered learners:
130
Layer5 Cloud REST API reference
174 API endpoints across 23 categories. This reference is generated from the OpenAPI schema used by the Layer5 docs.
Categories
Showing all endpoints.
Open a category, choose a tag, and pick an endpoint to view its request and response details here.
Get academy registrations
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/academy/admin/registrationsQuery parameters
| Name | Type | Required | Description |
|---|---|---|---|
pagesize | integer | No | Number of results per page |
page | integer | No | Page number |
contentType | array of string | No | Filter by content types |
status | array of string | No | Filter by registration status |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
data | array of object | Yes | The data of the curricularegistrationsresponse. |
page | integer | Yes | Current page number of the result set. |
page_size | integer | Yes | Number of items per page. |
total_count | integer (int64) | Yes | Total number of items available. |
text/plain
Schema: string
Schema: string
Get academy content summary
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/academy/admin/summaryReturned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
Schema: object
text/plain
Schema: string
Schema: string
Get a certificate by ID
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/academy/certificates/{certificateId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
certificateId | string | Yes | The ID of the certificate to retrieve |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
description | string | Yes | Description of the certificate |
expirationDate | string (date-time) | No | Date when the certificate expires. Dynamically calculated from issued_date and expires_in; not specified by instructors. |
expiresIn | integer | No | Number of months after which the certificate expires |
id | string (uuid) | Yes | Unique identifier for the certificate |
issuedDate | string (date-time) | Yes | Date when the certificate was issued |
issuingAuthorities | array of object | Yes | List of issuing authorities for the certificate |
orgId | string (uuid) | Yes | A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. |
recipientId | string (uuid) | Yes | ID of the recipient (user) who received the certificate |
recipientName | string | Yes | Name of the recipient (user) who received the certificate |
title | string | Yes | Title of the certificate |
text/plain
Schema: string
Schema: string
Get academy content
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/academy/curriculaQuery parameters
| Name | Type | Required | Description |
|---|---|---|---|
contentType | array of string | No | Filter content by content types |
visibility | array of string | No | Filter content by visibility (public/private) |
level | array of string | No | Filter content by difficulty level |
orgId | array of string | No | Filter content by organization IDs |
category | array of string | No | Filter content by categories |
status | array of string | No | Filter by registration status |
search | string | No | Search content by title |
sort | string | No | Sort results by a specific field (e.g., title, createdAt) |
order | string | No | Order of sorting (asc or desc) |
pagesize | integer | No | Number of results per page |
page | integer | No | Page number |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
data | array of object | Yes | The data of the academycurriculawithmetricslistresponse. |
total | integer | Yes | Total number of Curricula |
text/plain
Schema: string
Schema: string
Create a new academy curricula
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/academy/curriculaapplication/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
access_expires_at | string | No | Expiry time for curricula access |
access_status | string | Yes | Current access status of the curricula |
badge_id | string (uuid) | No | ID of the badge to be awarded on completion of this curricula |
metadata | object | Yes | Additional metadata about the Curricula |
org_id | string | Yes | Organization ID that owns this learning path |
team_id | string (uuid) | Yes | A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. |
title | string | Yes | Title of the curricula |
type | string | Yes | Type of the curricula |
workspace_id | string | Yes | ID of the workspace to which this Curricula belongs |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
badge_id | string (uuid) | No | ID of the badge to be awarded on completion of this curricula |
created_at | string | Yes | When the Curricula item was created |
deleted_at | string | Yes | No description provided. |
id | string (uuid) | Yes | Id of the Curricula |
invite_id | string | No | ID of the invite associated with this Curricula |
level | string | Yes | Level of the Curricula |
metadata | object | Yes | Additional metadata about the Curricula |
org_id | string | Yes | Organization ID that owns this learning path |
slug | string | Yes | slug of the Curricula |
status | string | Yes | Status of the Curricula |
type | string | Yes | No description provided. |
updated_at | string | Yes | When the Curricula was last updated |
visibility | string | Yes | Visibility of the Curricula |
workspace_id | string | No | ID of the workspace to which this Curricula belongs |
text/plain
Schema: string
Schema: string
Get academy content
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/academy/curricula/registeredQuery parameters
| Name | Type | Required | Description |
|---|---|---|---|
contentType | array of string | No | Filter content by content types |
orgId | array of string | No | Filter content by organization IDs |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
data | array of object | Yes | The data of the academycurriculalistresponse. |
total | integer | Yes | Total number of Curricula |
text/plain
Schema: string
Schema: string
Withdraw a user from academy content
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/academy/curricula/registrations/{id}/withdrawPath parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The ID of the curricula |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
certificate | object | Yes | Issued certificate for completing the curricula under registration |
content_id | string (uuid) | Yes | ID of the course content |
created_at | string (date-time) | Yes | When the registration was created |
deleted_at | string (date-time) | No | Timestamp when the resource was deleted. |
id | string (uuid) | Yes | A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. |
metadata | object | Yes | Additional metadata about the registration |
org_id | string (uuid) | Yes | A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. |
status | string | Yes | Status of the user’s course registration |
updated_at | string (date-time) | Yes | When the registration was updated |
user_id | string (uuid) | Yes | A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get a single academy curricula by ID
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/academy/curricula/{id}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The ID of the curricula |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
badge_id | string (uuid) | No | ID of the badge to be awarded on completion of this curricula |
created_at | string | Yes | When the Curricula item was created |
deleted_at | string | Yes | No description provided. |
id | string (uuid) | Yes | Id of the Curricula |
invitation | object | No | Invitation entity schema. |
invite_id | string | No | ID of the invite associated with this Curricula |
level | string | Yes | Level of the Curricula |
metadata | object | Yes | Additional metadata about the Curricula |
org_id | string | Yes | Organization ID that owns this learning path |
registration_count | number | Yes | Number of registrations associated with this curriculum. |
slug | string | Yes | slug of the Curricula |
status | string | Yes | Status of the Curricula |
type | string | Yes | No description provided. |
updated_at | string | Yes | When the Curricula was last updated |
visibility | string | Yes | Visibility of the Curricula |
workspace_id | string | No | ID of the workspace to which this Curricula belongs |
text/plain
Schema: string
Schema: string
Update an existing academy curricula by ID
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/academy/curricula/{id}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The ID of the curricula |
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
access_expires_at | string | No | Expiry time for curricula access |
access_status | string | Yes | Current access status of the curricula |
badge_id | string (uuid) | No | ID of the badge to be awarded on completion of this curricula |
metadata | object | Yes | Additional metadata about the Curricula |
org_id | string | Yes | Organization ID that owns this learning path |
team_id | string (uuid) | Yes | A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. |
title | string | Yes | Title of the curricula |
type | string | Yes | Type of the curricula |
workspace_id | string | Yes | ID of the workspace to which this Curricula belongs |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
badge_id | string (uuid) | No | ID of the badge to be awarded on completion of this curricula |
created_at | string | Yes | When the Curricula item was created |
deleted_at | string | Yes | No description provided. |
id | string (uuid) | Yes | Id of the Curricula |
invitation | object | No | Invitation entity schema. |
invite_id | string | No | ID of the invite associated with this Curricula |
level | string | Yes | Level of the Curricula |
metadata | object | Yes | Additional metadata about the Curricula |
org_id | string | Yes | Organization ID that owns this learning path |
registration_count | number | Yes | Number of registrations associated with this curriculum. |
slug | string | Yes | slug of the Curricula |
status | string | Yes | Status of the Curricula |
type | string | Yes | No description provided. |
updated_at | string | Yes | When the Curricula was last updated |
visibility | string | Yes | Visibility of the Curricula |
workspace_id | string | No | ID of the workspace to which this Curricula belongs |
text/plain
Schema: string
Schema: string
Delete an academy curricula by ID
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/academy/curricula/{id}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The ID of the curricula |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
text/plain
Schema: string
Schema: string
Register a user to academy content
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/academy/registerapplication/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
contentId | string (uuid) | Yes | ID of the academy content to register for |
contentType | string | No | No description provided. |
user_id | string (uuid) | Yes | ID of the user registering for the content. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
certificate | object | Yes | Issued certificate for completing the curricula under registration |
content_id | string (uuid) | Yes | ID of the course content |
created_at | string (date-time) | Yes | When the registration was created |
deleted_at | string (date-time) | No | Timestamp when the resource was deleted. |
id | string (uuid) | Yes | A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. |
metadata | object | Yes | Additional metadata about the registration |
org_id | string (uuid) | Yes | A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. |
status | string | Yes | Status of the user’s course registration |
updated_at | string (date-time) | Yes | When the registration was updated |
user_id | string (uuid) | Yes | A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. |
text/plain
Schema: string
Schema: string
Start a Test by ID
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/academy/registrations/test-sessions/startapplication/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
registrationId | string (uuid) | Yes | ID of the associated registration. |
testAbsPath | string | Yes | The test abs path of the starttestrequest. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
date | string (date) | Yes | The date of the quiz. |
description | string | Yes | Description of the quiz. |
draft | boolean | Yes | The draft of the quiz. |
filePath | string | Yes | The file path of the quiz. |
final | boolean | Yes | Indicates if the quiz is final . i.e this quiz will used to evaluate the completion of parent section eg course , module , learning path |
id | string (uuid) | Yes | Quiz ID. |
lastmod | string (date) | Yes | The lastmod of the quiz. |
layout | string | Yes | The layout of the quiz. |
maxAttempts | integer | Yes | Maximum number of attempts allowed for the quiz. A value of 0 indicates unlimited attempts. |
nextPage | object | Yes | No description provided. |
org_id | string (uuid) | Yes | Organization ID that owns this quiz |
parent | object | No | No description provided. |
passPercentage | number (float) | Yes | The pass percentage of the quiz. |
permalink | string | Yes | The permalink of the quiz. |
prerequisites | array of object | Yes | The prerequisites of the quiz. |
questions | array of object | Yes | The questions of the quiz. |
relPermalink | string | Yes | The rel permalink of the quiz. |
section | string | Yes | The section of the quiz. |
slug | string | Yes | The slug of the quiz. |
timeLimit | integer | Yes | Time limit for the quiz in minutes. A value of 0 indicates no time limit. |
title | string | Yes | The title of the quiz. |
totalMarks | integer | Yes | The total marks of the quiz. |
totalQuestions | integer | Yes | The total questions of the quiz. |
totalQuestionSets | integer | Yes | The total question sets of the quiz. |
totalQuestionsInBank | integer | Yes | The total questions in bank of the quiz. |
type | string | Yes | Type of the resource. |
text/plain
Schema: string
Schema: string
Submit a quiz for evaluation
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/academy/registrations/test-sessions/submitapplication/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
answers | array of object | Yes | The answers of the quizsubmission. |
quizAbsPath | string | Yes | The quiz abs path of the quizsubmission. |
registrationId | string (uuid) | Yes | ID of the associated registration. |
testSessionId | string (uuid) | Yes | A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. |
user_id | string (uuid) | Yes | ID of the user who owns or created this resource. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
attemptedAt | string (date-time) | Yes | The attempted at of the quizevaluationresult. |
attempts | integer | Yes | The attempts of the quizevaluationresult. |
correctSubmissions | object | Yes | The correct submissions of the quizevaluationresult. |
passed | boolean | Yes | The passed of the quizevaluationresult. |
passPercentage | number (float) | Yes | The pass percentage of the quizevaluationresult. |
percentageScored | number (float) | Yes | The percentage scored of the quizevaluationresult. |
quiz | object | Yes | No description provided. |
score | integer | Yes | The score of the quizevaluationresult. |
totalMarks | integer | Yes | The total marks of the quizevaluationresult. |
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
details | string | No | The details of the errorresponse. |
error | string | No | The error of the errorresponse. |
text/plain
Schema: string
Schema: string
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
details | string | No | The details of the errorresponse. |
error | string | No | The error of the errorresponse. |
Get test metadata
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/academy/registrations/testsQuery parameters
| Name | Type | Required | Description |
|---|---|---|---|
absPath | string | Yes | The absolute path of the test to retrieve |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
date | string (date) | Yes | The date of the quiz. |
description | string | Yes | Description of the quiz. |
draft | boolean | Yes | The draft of the quiz. |
filePath | string | Yes | The file path of the quiz. |
final | boolean | Yes | Indicates if the quiz is final . i.e this quiz will used to evaluate the completion of parent section eg course , module , learning path |
id | string (uuid) | Yes | Quiz ID. |
lastmod | string (date) | Yes | The lastmod of the quiz. |
layout | string | Yes | The layout of the quiz. |
maxAttempts | integer | Yes | Maximum number of attempts allowed for the quiz. A value of 0 indicates unlimited attempts. |
nextPage | object | Yes | No description provided. |
org_id | string (uuid) | Yes | Organization ID that owns this quiz |
parent | object | No | No description provided. |
passPercentage | number (float) | Yes | The pass percentage of the quiz. |
permalink | string | Yes | The permalink of the quiz. |
prerequisites | array of object | Yes | The prerequisites of the quiz. |
questions | array of object | Yes | The questions of the quiz. |
relPermalink | string | Yes | The rel permalink of the quiz. |
section | string | Yes | The section of the quiz. |
slug | string | Yes | The slug of the quiz. |
timeLimit | integer | Yes | Time limit for the quiz in minutes. A value of 0 indicates no time limit. |
title | string | Yes | The title of the quiz. |
totalMarks | integer | Yes | The total marks of the quiz. |
totalQuestions | integer | Yes | The total questions of the quiz. |
totalQuestionSets | integer | Yes | The total question sets of the quiz. |
totalQuestionsInBank | integer | Yes | The total questions in bank of the quiz. |
type | string | Yes | Type of the resource. |
text/plain
Schema: string
Schema: string
Get registration information for academy content
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/academy/registrations/{contentId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
contentId | string | Yes | The ID of the content to retrieve registration data for |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
status | string | No | Filter registrations by status (e.g., registered, completed) |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
certificate | object | Yes | Issued certificate for completing the curricula under registration |
content_id | string (uuid) | Yes | ID of the course content |
created_at | string (date-time) | Yes | When the registration was created |
deleted_at | string (date-time) | No | Timestamp when the resource was deleted. |
id | string (uuid) | Yes | A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. |
metadata | object | Yes | Additional metadata about the registration |
org_id | string (uuid) | Yes | A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. |
status | string | Yes | Status of the user’s course registration |
updated_at | string (date-time) | Yes | When the registration was updated |
user_id | string (uuid) | Yes | A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. |
text/plain
Schema: string
Schema: string
Get all tests for a registration
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/academy/registrations/{id}/test-sessionsPath parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The ID of the registration to retrieve tests for |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
page | string | No | Get responses by page |
pagesize | string | No | Get responses by pagesize |
testAbsPath | string | No | Filter tests by absolute path |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: array of
array of
object
Schema: array of
array of
object
text/plain
Schema: string
Schema: string
Update the current item in the progress tracker
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/academy/registrations/{registrationId}/progress-tracker/update-current-itemPath parameters
| Name | Type | Required | Description |
|---|---|---|---|
registrationId | string | Yes | The ID of the registration |
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
contentType | string | Yes | No description provided. |
itemData | object | Yes | No description provided. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
contentType | string | No | No description provided. |
itemData | object | No | No description provided. |
message | string | No | The message of the updatecurrentitemprogressresponse. |
progressTracker | object | No | No description provided. |
registrationId | string (uuid) | No | ID of the associated registration. |
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
details | string | No | The details of the errorresponse. |
error | string | No | The error of the errorresponse. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
details | string | No | The details of the errorresponse. |
error | string | No | The error of the errorresponse. |
Get a single learning path
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/academy/{type}/{orgId}/{slug}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
type | string | Yes | No description provided. |
orgId | string | Yes | No description provided. |
slug | string | Yes | No description provided. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
badge_id | string (uuid) | No | ID of the badge to be awarded on completion of this curricula |
created_at | string | Yes | When the Curricula item was created |
deleted_at | string | Yes | No description provided. |
id | string (uuid) | Yes | Id of the Curricula |
invite_id | string | No | ID of the invite associated with this Curricula |
level | string | Yes | Level of the Curricula |
metadata | object | Yes | Additional metadata about the Curricula |
org_id | string | Yes | Organization ID that owns this learning path |
slug | string | Yes | slug of the Curricula |
status | string | Yes | Status of the Curricula |
type | string | Yes | No description provided. |
updated_at | string | Yes | When the Curricula was last updated |
visibility | string | Yes | Visibility of the Curricula |
workspace_id | string | No | ID of the workspace to which this Curricula belongs |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get key by ID
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/auth/key/{keyId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
keyId | string (uuid) | Yes | Key ID |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. |
owner | string (uuid) | Yes | A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. |
function | string | Yes | Operation permitted by the key. |
category | string | Yes | Category for the key. |
subcategory | string | Yes | Subcategory for the key. |
description | string | Yes | Human readable description of the key. |
created_at | string (date-time) | Yes | Timestamp when the resource was created. |
updated_at | string (date-time) | Yes | Timestamp when the resource was updated. |
deleted_at | string (date-time) | No | SQL null Timestamp to handle null values of time. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Delete key
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/auth/key/{keyId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
keyId | string (uuid) | Yes | Key ID |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
List keychains
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/auth/keychainsQuery parameters
| Name | Type | Required | Description |
|---|---|---|---|
page | string | No | Get responses by page |
pagesize | string | No | Get responses by pagesize |
search | string | No | Get responses that match search param value |
order | string | No | Get ordered responses |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
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. |
keychains | array of object | Yes | The keychains of the keychainpage. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Create a keychain
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/auth/keychainsapplication/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Name of the keychain. |
owner | string (uuid) | No | Owner of the keychain. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | Unique identifier for the keychain. |
name | string | Yes | Name of the keychain. |
owner | string (uuid) | Yes | Owner of the keychain. |
created_at | string (date-time) | Yes | Timestamp when the resource was created. |
updated_at | string (date-time) | Yes | Timestamp when the resource was updated. |
deleted_at | string (date-time) | No | SQL null Timestamp to handle null values of time. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get keychain by ID
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/auth/keychains/{keychainId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
keychainId | string (uuid) | Yes | Keychain ID |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | Unique identifier for the keychain. |
name | string | Yes | Name of the keychain. |
owner | string (uuid) | Yes | Owner of the keychain. |
created_at | string (date-time) | Yes | Timestamp when the resource was created. |
updated_at | string (date-time) | Yes | Timestamp when the resource was updated. |
deleted_at | string (date-time) | No | SQL null Timestamp to handle null values of time. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Update keychain
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/auth/keychains/{keychainId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
keychainId | string (uuid) | Yes | Keychain ID |
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Name of the keychain. |
owner | string (uuid) | No | Owner of the keychain. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | Unique identifier for the keychain. |
name | string | Yes | Name of the keychain. |
owner | string (uuid) | Yes | Owner of the keychain. |
created_at | string (date-time) | Yes | Timestamp when the resource was created. |
updated_at | string (date-time) | Yes | Timestamp when the resource was updated. |
deleted_at | string (date-time) | No | SQL null Timestamp to handle null values of time. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Delete keychain
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/auth/keychains/{keychainId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
keychainId | string (uuid) | Yes | Keychain ID |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
List keys in a keychain
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/auth/keychains/{keychainId}/keysPath parameters
| Name | Type | Required | Description |
|---|---|---|---|
keychainId | string (uuid) | Yes | Keychain ID |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
page | string | No | Get responses by page |
pagesize | string | No | Get responses by pagesize |
search | string | No | Get responses that match search param value |
order | string | No | Get ordered responses |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
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. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Add key to keychain
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/auth/keychains/{keychainId}/{keyId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
keychainId | string (uuid) | Yes | Keychain ID |
keyId | string (uuid) | Yes | Key ID |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Remove key from keychain
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/auth/keychains/{keychainId}/{keyId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
keychainId | string (uuid) | Yes | Keychain ID |
keyId | string (uuid) | Yes | Key ID |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
List key
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/auth/keysQuery parameters
| Name | Type | Required | Description |
|---|---|---|---|
page | string | No | Get responses by page |
pagesize | string | No | Get responses by pagesize |
search | string | No | Get responses that match search param value |
order | string | No | Get ordered responses |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
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. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Create or update a key
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/auth/keysapplication/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | No | A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. |
function | string | No | Operation permitted by the key. |
category | string | No | Category for the key. |
subcategory | string | No | Subcategory for the key. |
description | string | No | Human readable description of the key. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. |
owner | string (uuid) | Yes | A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. |
function | string | Yes | Operation permitted by the key. |
category | string | Yes | Category for the key. |
subcategory | string | Yes | Subcategory for the key. |
description | string | Yes | Human readable description of the key. |
created_at | string (date-time) | Yes | Timestamp when the resource was created. |
updated_at | string (date-time) | Yes | Timestamp when the resource was updated. |
deleted_at | string (date-time) | No | SQL null Timestamp to handle null values of time. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get catalog content classes
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/catalog/content/classesQuery parameters
| Name | Type | Required | Description |
|---|---|---|---|
page | string | No | Get responses by page |
pagesize | string | No | Get responses by pagesize |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: array of
object
| Field | Type | Required | Description |
|---|---|---|---|
class | string | No | The class of the catalogcontentclass. |
description | string | No | Description of the catalogcontentclass. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get catalog content
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/catalog/content/{type}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
type | string | Yes | No description provided. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
page | string | No | Get responses by page |
pagesize | string | No | Get responses by pagesize |
search | string | No | Get responses that match search param value |
order | string | No | Get ordered responses |
type | string | No | No description provided. |
technology | string | No | No description provided. |
metrics | boolean | No | No description provided. |
class | string | No | No description provided. |
userId | string | No | No description provided. |
orgId | string | No | No description provided. |
workspaceId | string | No | No description provided. |
teamId | string | No | No description provided. |
populate | boolean | No | No description provided. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
categoryCount | array of object | No | The category count of the catalogcontentpage. |
filters | array of object | No | The filters of the catalogcontentpage. |
modelsCount | array of object | No | The models count of the catalogcontentpage. |
page | integer | No | Current page number of the result set. |
page_size | integer | No | Number of items per page. |
patterns | array of object | No | The patterns of the catalogcontentpage. |
total_count | integer | No | Total number of items available. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Publish catalog content
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/catalog/content/{type}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
type | string | Yes | No description provided. |
application/json
Schema: object
Schema: object
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
Schema: object
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Unpublish catalog content
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/catalog/content/{type}/unpublishPath parameters
| Name | Type | Required | Description |
|---|---|---|---|
type | string | Yes | No description provided. |
application/json
Schema: object
Schema: object
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
Schema: object
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get catalog requests
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/catalog/requestsQuery parameters
| Name | Type | Required | Description |
|---|---|---|---|
page | string | No | Get responses by page |
pagesize | string | No | Get responses by pagesize |
search | string | No | Get responses that match search param value |
order | string | No | Get ordered responses |
filter | string | No | No description provided. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
catalogRequests | array of object | No | The catalog requests of the catalogrequestspage. |
page | integer | No | Current page number of the result set. |
page_size | integer | No | Number of items per page. |
total_count | integer | No | Total number of items available. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Approve a catalog request
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/catalog/requests/approveapplication/json
Schema: object
Schema: object
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
Schema: object
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Deny a catalog request
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/catalog/requests/denyapplication/json
Schema: object
Schema: object
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
Schema: object
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Clone filter
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/content/filters/clone/{id}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | Design (Pattern) ID |
application/json
Schema: object
Schema: object
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
Schema: object
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get filter by ID
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/content/filters/{id}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | Design (Pattern) ID |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
Schema: object
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get designs
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/content/patternsQuery parameters
| Name | Type | Required | Description |
|---|---|---|---|
page | string | No | Get responses by page |
pagesize | string | No | Get responses by pagesize |
search | string | No | Get responses that match search param value |
order | string | No | Get ordered responses |
visibility | string | No | Filter by visibility (public, private, published) |
userId | string | No | UUID of User. Pass userId for fetching public and published designs. |
orgId | string | No | User’s organization ID. |
metrics | boolean | No | No description provided. |
workspaceId | string | No | No description provided. |
populate | boolean | No | No description provided. |
shared | boolean | No | No description provided. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
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. |
patterns | array of object | No | The patterns of the mesherypatternpage. |
resultType | string | No | The result type of the mesherypatternpage. |
total_count | integer | No | Total number of items available. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Save design
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/content/patternsapplication/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Name of the mesherypatternrequestbody. |
path | string | No | No description provided. |
patternData | object | No | No description provided. |
save | boolean | No | The save of the mesherypatternrequestbody. |
url | string (uri) | No | endpoint |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
catalogData | object | No | No description provided. |
created_at | string (date-time) | No | No description provided. |
id | string (uuid) | No | No description provided. |
location | object | No | No description provided. |
name | string | No | No description provided. |
patternFile | object | No | Designs are your primary tool for collaborative authorship of your infrastructure, workflow, and processes. |
updated_at | string (date-time) | No | No description provided. |
user_id | string (uuid) | No | No description provided. |
visibility | string | No | No description provided. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Clone design
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/content/patterns/clone/{id}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | Design (Pattern) ID |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
catalogData | object | No | No description provided. |
created_at | string (date-time) | No | No description provided. |
id | string (uuid) | No | No description provided. |
location | object | No | No description provided. |
name | string | No | No description provided. |
patternFile | object | No | Designs are your primary tool for collaborative authorship of your infrastructure, workflow, and processes. |
updated_at | string (date-time) | No | No description provided. |
user_id | string (uuid) | No | No description provided. |
visibility | string | No | No description provided. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Bulk delete designs
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/content/patterns/deleteapplication/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
patterns | array of object | No | The patterns of the mesherypatterndeleterequestbody. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Download design file
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/content/patterns/download/{id}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | Design (Pattern) ID |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/yaml
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get pattern resources
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/content/patterns/resourceQuery parameters
| Name | Type | Required | Description |
|---|---|---|---|
page | string | No | Get responses by page |
pagesize | string | No | Get responses by pagesize |
search | string | No | Get responses that match search param value |
order | string | No | Get ordered responses |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Save pattern resource
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/content/patterns/resourceReturned data
Status codes, content types, and response schemas returned by this endpoint.
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get pattern resource by ID
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/content/patterns/resource/{id}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | Design (Pattern) ID |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Delete pattern resource
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/content/patterns/resource/{id}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | Design (Pattern) ID |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Upload design source content
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/content/patterns/upload/{id}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | Design (Pattern) ID |
multipart/form-data
Schema: object
| 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
Status codes, content types, and response schemas returned by this endpoint.
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get design by ID
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/content/patterns/{id}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | Design (Pattern) ID |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
catalogData | object | No | No description provided. |
created_at | string (date-time) | No | No description provided. |
id | string (uuid) | No | No description provided. |
location | object | No | No description provided. |
name | string | No | No description provided. |
patternFile | object | No | Designs are your primary tool for collaborative authorship of your infrastructure, workflow, and processes. |
updated_at | string (date-time) | No | No description provided. |
user_id | string (uuid) | No | No description provided. |
visibility | string | No | No description provided. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Delete design by ID
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/content/patterns/{id}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | Design (Pattern) ID |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get views
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/content/viewsQuery 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. |
shared | boolean | No | No description provided. |
visibility | string | No | No description provided. |
orgId | string | No | No description provided. |
userId | string | No | No description provided. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
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. |
total_count | integer | No | Total number of items available. |
views | array of object | No | The views of the mesheryviewpage. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get a view by ID
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/content/views/{viewId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
viewId | string | Yes | No description provided. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
Schema: object
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Update a view
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/content/views/{viewId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
viewId | string | Yes | No description provided. |
application/json
Schema: object
Schema: object
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
Schema: object
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get all features associated with plans
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/entitlement/featuresReturned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: array of
object
| Field | Type | Required | Description |
|---|---|---|---|
created_at | string (date-time) | No | No description provided. |
id | string (uuid) | Yes | A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. |
name | string | Yes | Enumeration of possible feature types |
plan | object | No | No description provided. |
plan_id | string (uuid) | Yes | A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. |
quantity | number | Yes | Quantity of the feature allowed, use 9999999999 for unlimited |
updated_at | string (date-time) | No | No description provided. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get all plans supported by the system
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/entitlement/plansQuery parameters
| Name | Type | Required | Description |
|---|---|---|---|
page | string | No | Get responses by page |
pagesize | string | No | Get responses by pagesize |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: array of
object
| Field | Type | Required | Description |
|---|---|---|---|
cadence | string | Yes | No description provided. |
currency | string | Yes | No description provided. |
id | string (uuid) | Yes | A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. |
minimum_units | integer | Yes | Minimum number of units required for the plan |
name | string | Yes | Name of the plan |
price_per_unit | number | Yes | Price per unit of the plan |
unit | string | Yes | No description provided. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Read subscriptions
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Local development server
http://localhost:8080/api/entitlement/subscriptionsQuery parameters
| Name | Type | Required | Description |
|---|---|---|---|
page | string | No | Get responses by page |
pagesize | string | No | Get responses by pagesize |
order | string | No | Get ordered responses |
status | array of string | No | Filter subscriptions by status |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
page | integer | Yes | Current page number of the result set. |
page_size | integer | Yes | Number of items per page. |
subscriptions | array of object | Yes | Subscriptions returned in the current page of results. |
total_count | integer | Yes | Total number of items available. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Create a new subscription for an organization
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Local development server
http://localhost:8080/api/entitlement/subscriptions/createapplication/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
couponId | string | No | Coupon ID to apply |
email | string (email) | No | Email of the customer |
orgId | string (uuid) | No | Organization ID |
paymentProcessor | string | No | Supported payment processors |
planId | string | No | Price ID from the payment processor |
userCount | integer | No | Number of users in the organization |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
clientSecret | string | No | Client secret returned by the payment processor for the subscription checkout flow. |
subscriptionId | string | No | ID of the associated subscription. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get all features associated with plans
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/entitlement/subscriptions/organizations/{organizationId}/featuresPath parameters
| Name | Type | Required | Description |
|---|---|---|---|
organizationId | string (uuid) | Yes | The ID of the organization |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: array of
object
| Field | Type | Required | Description |
|---|---|---|---|
created_at | string (date-time) | No | No description provided. |
id | string (uuid) | Yes | A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. |
name | string | Yes | Enumeration of possible feature types |
plan | object | No | No description provided. |
plan_id | string (uuid) | Yes | A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. |
quantity | number | Yes | Quantity of the feature allowed, use 9999999999 for unlimited |
updated_at | string (date-time) | No | No description provided. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Handle webhook events from payment processors
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Local development server
http://localhost:8080/api/entitlement/subscriptions/webhooksapplication/json
Schema: object
Schema: object
Returned data
Status codes, content types, and response schemas returned by this endpoint.
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Cancel an existing subscription. The subscription will remain active until the end of the billing period and then it will be canceled.
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Local development server
http://localhost:8080/api/entitlement/subscriptions/{subscriptionId}/cancelPath parameters
| Name | Type | Required | Description |
|---|---|---|---|
subscriptionId | string | Yes | Subscription ID |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
No description provided.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
page | integer | Yes | Current page number of the result set. |
page_size | integer | Yes | Number of items per page. |
subscriptions | array of object | Yes | Subscriptions returned in the current page of results. |
total_count | integer | Yes | Total number of items available. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Upgrade or downgrade an existing subscription by changing one of the plans in the subscription
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Local development server
http://localhost:8080/api/entitlement/subscriptions/{subscriptionId}/upgradePath parameters
| Name | Type | Required | Description |
|---|---|---|---|
subscriptionId | string | Yes | Subscription ID |
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
newPlanId | string (uuid) | No | New Plan id that is being changed to |
oldPlanId | string (uuid) | No | Old Plan id that is being changed |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
No description provided.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
billing_id | string | Yes | Billing ID of the subscription. This is the ID of the subscription in the billing system. eg Stripe |
created_at | string (date-time) | No | No description provided. |
deleted_at | string (date-time) | No | No description provided. |
end_date | string (date-time) | No | No description provided. |
id | string (uuid) | Yes | A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. |
org_id | string (uuid) | Yes | A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. |
plan | object | No | Plan entity schema. |
plan_id | string (uuid) | Yes | A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. |
quantity | integer | Yes | number of units subscribed (eg number of users) |
start_date | string (date-time) | No | No description provided. |
status | string | Yes | Possible statuses of a Stripe subscription. |
updated_at | string (date-time) | No | No description provided. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Preview the invoice for upgrading or downgrading an existing subscription by changing one of the plans in the subscription
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Local development server
http://localhost:8080/api/entitlement/subscriptions/{subscriptionId}/upgrade-previewPath parameters
| Name | Type | Required | Description |
|---|---|---|---|
subscriptionId | string | Yes | Subscription ID |
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
newPlanId | string (uuid) | No | New Plan id that is being changed to |
oldPlanId | string (uuid) | No | Old Plan id that is being changed |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
Schema: object
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get all environments
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Server development server URL (controlled via PORT environment variable)
http://localhost:9081/api/environmentsQuery 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
Status codes, content types, and response schemas returned by this endpoint.
application/json
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. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Create an environment
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Server development server URL (controlled via PORT environment variable)
http://localhost:9081/api/environmentsapplication/json
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
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| 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"
}text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get environment by ID
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Server development server URL (controlled via PORT environment variable)
http://localhost:9081/api/environments/{environmentId}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
Status codes, content types, and response schemas returned by this endpoint.
application/json
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. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Update an environment
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Server development server URL (controlled via PORT environment variable)
http://localhost:9081/api/environments/{environmentId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
environmentId | string (uuid) | Yes | Environment ID |
application/json
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
Status codes, content types, and response schemas returned by this endpoint.
application/json
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. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Delete an environment
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Server development server URL (controlled via PORT environment variable)
http://localhost:9081/api/environments/{environmentId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
environmentId | string (uuid) | Yes | Environment ID |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get environment connections
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Server development server URL (controlled via PORT environment variable)
http://localhost:9081/api/environments/{environmentId}/connectionsPath 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
Status codes, content types, and response schemas returned by this endpoint.
application/json
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. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Add connection to environment
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/environments/{environmentId}/connections/{connectionId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
environmentId | string (uuid) | Yes | Environment ID |
connectionId | string (uuid) | Yes | Connection ID |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Remove connection from environment
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/environments/{environmentId}/connections/{connectionId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
environmentId | string (uuid) | Yes | Environment ID |
connectionId | string (uuid) | Yes | Connection ID |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get events aggregate summary
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/eventsQuery parameters
| Name | Type | Required | Description |
|---|---|---|---|
cumulative | boolean | No | No description provided. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
audit | integer | No | The audit of the eventsaggregate. |
Get events list
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/events/listQuery 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
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
data | array of object | No | The data of the eventspage. |
page | integer | No | No description provided. |
page_size | integer | No | No description provided. |
total_count | integer | No | No description provided. |
Get event summary by user
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/events/summaryQuery 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
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
data | array of object | No | The data of the eventsummarypage. |
page | integer | No | Current page number of the result set. |
page_size | integer | No | Number of items per page. |
total_count | integer | No | Total number of items available. |
Get event types
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/events/typesQuery parameters
| Name | Type | Required | Description |
|---|---|---|---|
page | string | No | Get responses by page |
pagesize | string | No | Get responses by pagesize |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: array of
object
| Field | Type | Required | Description |
|---|---|---|---|
action | string | No | The action of the eventtype. |
category | string | No | The category of the eventtype. |
Get available badges
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/identity/badgesReturned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
badges | object | No | The badges of the badgespage. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Read organizations
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/identity/orgsQuery 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
Status codes, content types, and response schemas returned by this endpoint.
application/json
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. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Create an organization
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/identity/orgsapplication/json
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
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| 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. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get organization by domain
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/identity/orgs/by-domainQuery parameters
| Name | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | No description provided. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
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. |
text/plain
Schema: string
Schema: string
Read an organization
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/identity/orgs/{orgId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
orgId | string (uuid) | Yes | No description provided. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| 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. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Update an organization
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/identity/orgs/{orgId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
orgId | string (uuid) | Yes | No description provided. |
application/json
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
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| 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. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Delete an organization
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/identity/orgs/{orgId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
orgId | string (uuid) | Yes | No description provided. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get organization preferences
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/identity/orgs/{orgId}/preferencesPath parameters
| Name | Type | Required | Description |
|---|---|---|---|
orgId | string (uuid) | Yes | No description provided. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
preferences | object | Yes | No description provided. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get organization roles
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.layer5.io/api/identity/orgs/{orgId}/rolesMeshery Cloud staging server URL
https://staging-cloud.layer5.io/api/identity/orgs/{orgId}/rolesMeshery Cloud development server URL
http://localhost:9876/api/identity/orgs/{orgId}/rolesPath parameters
| Name | Type | Required | Description |
|---|---|---|---|
orgId | string (uuid) | Yes | Organization ID |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
page | string | No | Get responses by page |
pagesize | string | No | Get responses by pagesize |
search | string | No | Get responses that match search param value |
order | string | No | Get ordered responses |
all | boolean | No | Get all possible entries |
selector | string | No | Role grouping selector such as provider, organization, or team. |
teamId | string (uuid) | No | Team ID used when selector is team. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
page | integer | Yes | Current page number (zero-based). |
page_size | integer | Yes | Number of roles per page. |
total_count | integer | Yes | Total number of roles across all pages. |
roles | array of object | Yes | The roles of the rolespage. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Upsert organization role
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.layer5.io/api/identity/orgs/{orgId}/rolesMeshery Cloud staging server URL
https://staging-cloud.layer5.io/api/identity/orgs/{orgId}/rolesMeshery Cloud development server URL
http://localhost:9876/api/identity/orgs/{orgId}/rolesPath parameters
| Name | Type | Required | Description |
|---|---|---|---|
orgId | string (uuid) | Yes | Organization ID |
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | No | A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. |
role_name | string | Yes | Unique name of the role. |
description | string | Yes | Human-readable description of the role. |
created_at | string (date-time) | No | Timestamp when the resource was created. |
updated_at | string (date-time) | No | Timestamp when the resource was updated. |
deleted_at | string (date-time) | No | Timestamp when the role was soft-deleted. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | No | A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. |
role_name | string | Yes | Unique name of the role. |
description | string | Yes | Human-readable description of the role. |
created_at | string (date-time) | No | Timestamp when the resource was created. |
updated_at | string (date-time) | No | Timestamp when the resource was updated. |
deleted_at | string (date-time) | No | Timestamp when the role was soft-deleted. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Bulk edit role holders
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.layer5.io/api/identity/orgs/{orgId}/rolesMeshery Cloud staging server URL
https://staging-cloud.layer5.io/api/identity/orgs/{orgId}/rolesMeshery Cloud development server URL
http://localhost:9876/api/identity/orgs/{orgId}/rolesPath parameters
| Name | Type | Required | Description |
|---|---|---|---|
orgId | string (uuid) | Yes | Organization ID |
application/json
Schema: array of
object
| Field | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | No | A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. |
user_id | string (uuid) | No | A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. |
username | string | No | The username of the userroleupdaterequest. |
email | string (email) | No | Email address. |
firstName | string | No | The first name of the userroleupdaterequest. |
lastName | string | No | The last name of the userroleupdaterequest. |
status | string | No | Current status of the resource. |
roleNames | array of string | No | The role names of the userroleupdaterequest. |
created_at | string (date-time) | No | No description provided. |
updated_at | string (date-time) | No | No description provided. |
deleted_at | string (date-time) | No | SQL null Timestamp to handle null values of time. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get keychains for role
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.layer5.io/api/identity/orgs/{orgId}/roles/{roleId}/keychainsMeshery Cloud staging server URL
https://staging-cloud.layer5.io/api/identity/orgs/{orgId}/roles/{roleId}/keychainsMeshery Cloud development server URL
http://localhost:9876/api/identity/orgs/{orgId}/roles/{roleId}/keychainsPath parameters
| Name | Type | Required | Description |
|---|---|---|---|
orgId | string (uuid) | Yes | Organization ID |
roleId | string (uuid) | Yes | Role ID |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
page | string | No | Get responses by page |
pagesize | string | No | Get responses by pagesize |
search | string | No | Get responses that match search param value |
order | string | No | Get ordered responses |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
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. |
keychains | array of object | Yes | The keychains of the keychainpage. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Assign keychain to role
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.layer5.io/api/identity/orgs/{orgId}/roles/{roleId}/keychains/{keychainId}Meshery Cloud staging server URL
https://staging-cloud.layer5.io/api/identity/orgs/{orgId}/roles/{roleId}/keychains/{keychainId}Meshery Cloud development server URL
http://localhost:9876/api/identity/orgs/{orgId}/roles/{roleId}/keychains/{keychainId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
orgId | string (uuid) | Yes | Organization ID |
roleId | string (uuid) | Yes | Role ID |
keychainId | string (uuid) | Yes | Keychain ID |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Unassign keychain from role
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.layer5.io/api/identity/orgs/{orgId}/roles/{roleId}/keychains/{keychainId}Meshery Cloud staging server URL
https://staging-cloud.layer5.io/api/identity/orgs/{orgId}/roles/{roleId}/keychains/{keychainId}Meshery Cloud development server URL
http://localhost:9876/api/identity/orgs/{orgId}/roles/{roleId}/keychains/{keychainId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
orgId | string (uuid) | Yes | Organization ID |
roleId | string (uuid) | Yes | Role ID |
keychainId | string (uuid) | Yes | Keychain ID |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get all teams for an organization
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.meshery.io/api/identity/orgs/{orgId}/teamsMeshery Cloud staging server URL
https://staging-cloud.meshery.io/api/identity/orgs/{orgId}/teamsMeshery Cloud development server URL (controlled via PORT environment variable)
http://localhost:9876/api/identity/orgs/{orgId}/teamsPath 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
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| 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. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Create a team
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.meshery.io/api/identity/orgs/{orgId}/teamsMeshery Cloud staging server URL
https://staging-cloud.meshery.io/api/identity/orgs/{orgId}/teamsMeshery Cloud development server URL (controlled via PORT environment variable)
http://localhost:9876/api/identity/orgs/{orgId}/teamsPath parameters
| Name | Type | Required | Description |
|---|---|---|---|
orgId | string (uuid) | Yes | Organization ID |
application/json
Schema: object
| 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
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| 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. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get a team by ID
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.meshery.io/api/identity/orgs/{orgId}/teams/{teamId}Meshery Cloud staging server URL
https://staging-cloud.meshery.io/api/identity/orgs/{orgId}/teams/{teamId}Meshery Cloud development server URL (controlled via PORT environment variable)
http://localhost:9876/api/identity/orgs/{orgId}/teams/{teamId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
orgId | string (uuid) | Yes | Organization ID |
teamId | string (uuid) | Yes | Team ID |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| 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. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Add team to organization or soft delete team
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.meshery.io/api/identity/orgs/{orgId}/teams/{teamId}Meshery Cloud staging server URL
https://staging-cloud.meshery.io/api/identity/orgs/{orgId}/teams/{teamId}Meshery Cloud development server URL (controlled via PORT environment variable)
http://localhost:9876/api/identity/orgs/{orgId}/teams/{teamId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
orgId | string (uuid) | Yes | No description provided. |
teamId | string (uuid) | Yes | No description provided. |
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
action | string | No | Internal action to perform on the team resource. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
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. |
Update a team
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.meshery.io/api/identity/orgs/{orgId}/teams/{teamId}Meshery Cloud staging server URL
https://staging-cloud.meshery.io/api/identity/orgs/{orgId}/teams/{teamId}Meshery Cloud development server URL (controlled via PORT environment variable)
http://localhost:9876/api/identity/orgs/{orgId}/teams/{teamId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
orgId | string (uuid) | Yes | Organization ID |
teamId | string (uuid) | Yes | Team ID |
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
description | string | No | Updated team description |
name | string | No | Updated team name |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| 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. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Delete a team
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.meshery.io/api/identity/orgs/{orgId}/teams/{teamId}Meshery Cloud staging server URL
https://staging-cloud.meshery.io/api/identity/orgs/{orgId}/teams/{teamId}Meshery Cloud development server URL (controlled via PORT environment variable)
http://localhost:9876/api/identity/orgs/{orgId}/teams/{teamId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
orgId | string (uuid) | Yes | Organization ID |
teamId | string (uuid) | Yes | Team ID |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Remove team from organization
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/identity/orgs/{orgId}/teams/{teamId}/removePath parameters
| Name | Type | Required | Description |
|---|---|---|---|
orgId | string (uuid) | Yes | No description provided. |
teamId | string (uuid) | Yes | No description provided. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
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. |
Get users that are not in a team
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.meshery.io/api/identity/orgs/{orgId}/teams/{teamId}/usersMeshery Cloud staging server URL
https://staging-cloud.meshery.io/api/identity/orgs/{orgId}/teams/{teamId}/usersMeshery Cloud development server URL (controlled via PORT environment variable)
http://localhost:9876/api/identity/orgs/{orgId}/teams/{teamId}/usersPath 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
Status codes, content types, and response schemas returned by this endpoint.
application/json
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. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Add a user to a team
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.meshery.io/api/identity/orgs/{orgId}/teams/{teamId}/users/{userId}Meshery Cloud staging server URL
https://staging-cloud.meshery.io/api/identity/orgs/{orgId}/teams/{teamId}/users/{userId}Meshery Cloud development server URL (controlled via PORT environment variable)
http://localhost:9876/api/identity/orgs/{orgId}/teams/{teamId}/users/{userId}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
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| 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 |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Remove a user from a team
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.meshery.io/api/identity/orgs/{orgId}/teams/{teamId}/users/{userId}Meshery Cloud staging server URL
https://staging-cloud.meshery.io/api/identity/orgs/{orgId}/teams/{teamId}/users/{userId}Meshery Cloud development server URL (controlled via PORT environment variable)
http://localhost:9876/api/identity/orgs/{orgId}/teams/{teamId}/users/{userId}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
Status codes, content types, and response schemas returned by this endpoint.
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get organization users
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/identity/orgs/{orgId}/usersPath 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
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| 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. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Invite users to an organization
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/identity/orgs/{orgId}/users/invitePath parameters
| Name | Type | Required | Description |
|---|---|---|---|
orgId | string | Yes | The ID of the organization |
application/json
Schema: object
Schema: object
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
Schema: object
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get User Keys
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/identity/orgs/{orgId}/users/keysPath 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
Status codes, content types, and response schemas returned by this endpoint.
application/json
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. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Add user to organization
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/identity/orgs/{orgId}/users/{userId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
orgId | string (uuid) | Yes | No description provided. |
userId | string | Yes | No description provided. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
Schema: object
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Remove user from organization
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/identity/orgs/{orgId}/users/{userId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
orgId | string (uuid) | Yes | No description provided. |
userId | string | Yes | No description provided. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
text/plain
Schema: string
Schema: string
Add role holder
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.layer5.io/api/identity/rolesMeshery Cloud staging server URL
https://staging-cloud.layer5.io/api/identity/rolesMeshery Cloud development server URL
http://localhost:9876/api/identity/rolesapplication/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
email | string (email) | Yes | Email of the user to assign roles to. |
roleNames | array of string | Yes | List of role names to assign. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Delete role
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.layer5.io/api/identity/roles/{id}Meshery Cloud staging server URL
https://staging-cloud.layer5.io/api/identity/roles/{id}Meshery Cloud development server URL
http://localhost:9876/api/identity/roles/{id}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | Role ID |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get all users in a team
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.meshery.io/api/identity/teams/{teamId}/usersMeshery Cloud staging server URL
https://staging-cloud.meshery.io/api/identity/teams/{teamId}/usersMeshery Cloud development server URL (controlled via PORT environment variable)
http://localhost:9876/api/identity/teams/{teamId}/usersPath 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
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| 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. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get tokens
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.layer5.io/api/identity/tokensMeshery Cloud staging server URL
https://staging-cloud.layer5.io/api/identity/tokensMeshery Cloud development server URL
http://localhost:9876/api/identity/tokensQuery parameters
| Name | Type | Required | Description |
|---|---|---|---|
isOAuth | boolean | No | Whether to retrieve OAuth-backed sessions instead of API tokens. |
page | string | No | Get responses by page |
pagesize | string | No | Get responses by pagesize |
search | string | No | Get responses that match search param value |
order | string | No | Get ordered responses |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
tokens | array of object | Yes | The tokens of the tokenpage. |
total_count | integer | Yes | Total number of tokens across all pages. |
page | integer | Yes | Current page number (zero-based). |
page_size | integer | Yes | Number of tokens per page. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Generate token
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.layer5.io/api/identity/tokensMeshery Cloud staging server URL
https://staging-cloud.layer5.io/api/identity/tokensMeshery Cloud development server URL
http://localhost:9876/api/identity/tokensQuery parameters
| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Name of the token. |
purpose | string | No | Purpose for which the token is generated. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
tokens | array of object | Yes | The tokens of the tokenpage. |
total_count | integer | Yes | Total number of tokens across all pages. |
page | integer | Yes | Current page number (zero-based). |
page_size | integer | Yes | Number of tokens per page. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Delete token
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.layer5.io/api/identity/tokensMeshery Cloud staging server URL
https://staging-cloud.layer5.io/api/identity/tokensMeshery Cloud development server URL
http://localhost:9876/api/identity/tokensQuery parameters
| Name | Type | Required | Description |
|---|---|---|---|
tokenId | string (uuid) | Yes | ID of the token. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
tokens | array of object | Yes | The tokens of the tokenpage. |
total_count | integer | Yes | Total number of tokens across all pages. |
page | integer | Yes | Current page number (zero-based). |
page_size | integer | Yes | Number of tokens per page. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Issue indefinite lifetime token
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.layer5.io/api/identity/tokens/infiniteMeshery Cloud staging server URL
https://staging-cloud.layer5.io/api/identity/tokens/infiniteMeshery Cloud development server URL
http://localhost:9876/api/identity/tokens/infiniteQuery parameters
| Name | Type | Required | Description |
|---|---|---|---|
userId | string (uuid) | Yes | UUID of the user. |
provider | string | Yes | Remote provider. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
tokens | array of object | Yes | The tokens of the tokenpage. |
total_count | integer | Yes | Total number of tokens across all pages. |
page | integer | Yes | Current page number (zero-based). |
page_size | integer | Yes | Number of tokens per page. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get token by ID
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.layer5.io/api/identity/tokens/{id}Meshery Cloud staging server URL
https://staging-cloud.layer5.io/api/identity/tokens/{id}Meshery Cloud development server URL
http://localhost:9876/api/identity/tokens/{id}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | Token ID |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | Unique identifier for the token. |
user_id | string (uuid) | Yes | UUID of the user who owns the token. |
provider | string | Yes | Authentication provider associated with the token. |
access_token | string | No | Access token value. |
refresh_token | string | No | Refresh token value when applicable. |
name | string | No | Human-readable token name. |
purpose | string | No | Purpose for which the token was created. |
is_oauth | boolean | No | Whether this entry represents an OAuth session. |
created_at | string (date-time) | No | Timestamp when the resource was created. |
updated_at | string (date-time) | No | Timestamp when the resource was updated. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Assign badges to a user
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/identity/users/badgesapplication/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
badges | array of string | No | The badges of the badgeassignment. |
notify | boolean | No | The notify of the badgeassignment. |
user_id | string (uuid) | No | ID of the user who owns or created this resource. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
Schema: object
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get current user profile
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/identity/users/profileReturned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| 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) |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get user profile by ID
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/identity/users/profile/{id}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | User ID |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| 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) |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get signup requests
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/identity/users/requestQuery 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
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
data | array of object | No | The data of the signuprequestspage. |
page | integer | No | Current page number of the result set. |
page_size | integer | No | Number of items per page. |
total_count | integer | No | Total number of items available. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Create a signup request
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/identity/users/requestapplication/json
Schema: object
Schema: object
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
Schema: object
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Approve a signup request
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/identity/users/request/approveReturned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
Schema: object
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Deny a signup request
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/identity/users/request/denyReturned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
Schema: object
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get signup request notification summary
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/identity/users/request/notificationReturned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
Schema: object
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get all connections
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/integrations/connectionsQuery 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
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| 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 |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Register a new connection
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/integrations/connectionsapplication/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
credential_id | 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 |
sub_type | string | Yes | Connection sub-type |
type | string | Yes | Connection type |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| 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. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get Kubernetes context
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/integrations/connections/kubernetes/{connectionId}/contextPath parameters
| Name | Type | Required | Description |
|---|---|---|---|
connectionId | string (uuid) | Yes | Connection ID |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
Schema: object
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Delete Meshery instance connection
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/integrations/connections/meshery/{mesheryServerId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
mesheryServerId | string (uuid) | Yes | Meshery server ID |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get connection by ID
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/integrations/connections/{connectionId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
connectionId | string (uuid) | Yes | Connection ID |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| 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. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Update a connection
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/integrations/connections/{connectionId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
connectionId | string (uuid) | Yes | Connection ID |
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
credential_id | 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 |
sub_type | string | Yes | Connection sub-type |
type | string | Yes | Connection type |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| 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. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Delete a connection
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/integrations/connections/{connectionId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
connectionId | string (uuid) | Yes | Connection ID |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get credentials
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.layer5.io/api/integrations/credentialsMeshery Cloud staging server URL
https://staging-cloud.layer5.io/api/integrations/credentialsMeshery Cloud development server URL
http://localhost:9876/api/integrations/credentialsQuery parameters
| Name | Type | Required | Description |
|---|---|---|---|
page | string | No | Get responses by page |
pagesize | string | No | Get responses by pagesize |
search | string | No | Get responses that match search param value |
order | string | No | Get ordered responses |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
credentials | array of object | Yes | The credentials of the credentialpage. |
total_count | integer | Yes | Total number of credentials across all pages. |
page | integer | Yes | Current page number (zero-based). |
page_size | integer | Yes | Number of credentials per page. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Save credential
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.layer5.io/api/integrations/credentialsMeshery Cloud staging server URL
https://staging-cloud.layer5.io/api/integrations/credentialsMeshery Cloud development server URL
http://localhost:9876/api/integrations/credentialsapplication/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | No | Unique identifier for the credential. |
name | string | Yes | Human-readable name for the credential. |
user_id | string (uuid) | No | UUID of the user who owns this credential. |
type | string | Yes | Credential type (e.g. token, basic, AWS). |
secret | object | No | Key-value pairs containing the sensitive credential data. |
created_at | string (date-time) | No | Timestamp when the resource was created. |
updated_at | string (date-time) | No | Timestamp when the resource was updated. |
deleted_at | string (date-time) | No | Timestamp when the credential was soft-deleted. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | No | Unique identifier for the credential. |
name | string | Yes | Human-readable name for the credential. |
user_id | string (uuid) | No | UUID of the user who owns this credential. |
type | string | Yes | Credential type (e.g. token, basic, AWS). |
secret | object | No | Key-value pairs containing the sensitive credential data. |
created_at | string (date-time) | No | Timestamp when the resource was created. |
updated_at | string (date-time) | No | Timestamp when the resource was updated. |
deleted_at | string (date-time) | No | Timestamp when the credential was soft-deleted. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Update credential
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.layer5.io/api/integrations/credentialsMeshery Cloud staging server URL
https://staging-cloud.layer5.io/api/integrations/credentialsMeshery Cloud development server URL
http://localhost:9876/api/integrations/credentialsapplication/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | No | Unique identifier for the credential. |
name | string | Yes | Human-readable name for the credential. |
user_id | string (uuid) | No | UUID of the user who owns this credential. |
type | string | Yes | Credential type (e.g. token, basic, AWS). |
secret | object | No | Key-value pairs containing the sensitive credential data. |
created_at | string (date-time) | No | Timestamp when the resource was created. |
updated_at | string (date-time) | No | Timestamp when the resource was updated. |
deleted_at | string (date-time) | No | Timestamp when the credential was soft-deleted. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | No | Unique identifier for the credential. |
name | string | Yes | Human-readable name for the credential. |
user_id | string (uuid) | No | UUID of the user who owns this credential. |
type | string | Yes | Credential type (e.g. token, basic, AWS). |
secret | object | No | Key-value pairs containing the sensitive credential data. |
created_at | string (date-time) | No | Timestamp when the resource was created. |
updated_at | string (date-time) | No | Timestamp when the resource was updated. |
deleted_at | string (date-time) | No | Timestamp when the credential was soft-deleted. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Delete credential
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.layer5.io/api/integrations/credentialsMeshery Cloud staging server URL
https://staging-cloud.layer5.io/api/integrations/credentialsMeshery Cloud development server URL
http://localhost:9876/api/integrations/credentialsQuery parameters
| Name | Type | Required | Description |
|---|---|---|---|
credentialId | string (uuid) | Yes | Credential ID |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get credential by ID
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.layer5.io/api/integrations/credentials/{id}Meshery Cloud staging server URL
https://staging-cloud.layer5.io/api/integrations/credentials/{id}Meshery Cloud development server URL
http://localhost:9876/api/integrations/credentials/{id}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | Credential ID |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | No | Unique identifier for the credential. |
name | string | Yes | Human-readable name for the credential. |
user_id | string (uuid) | No | UUID of the user who owns this credential. |
type | string | Yes | Credential type (e.g. token, basic, AWS). |
secret | object | No | Key-value pairs containing the sensitive credential data. |
created_at | string (date-time) | No | Timestamp when the resource was created. |
updated_at | string (date-time) | No | Timestamp when the resource was updated. |
deleted_at | string (date-time) | No | Timestamp when the credential was soft-deleted. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get mesh model models
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/integrations/meshmodels/modelsQuery parameters
| Name | Type | Required | Description |
|---|---|---|---|
page | string | No | No description provided. |
pagesize | string | No | No description provided. |
search | string | No | No description provided. |
order | string | No | No description provided. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
models | array of object | No | The models of the meshmodelmodelspage. |
page | integer | No | Current page number of the result set. |
page_size | integer | No | Number of items per page. |
total_count | integer | No | Total number of items available. |
text/plain
Schema: string
Schema: string
Register mesh models
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/meshmodels/registermultipart/form-data
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
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
message | string | No | No description provided. |
text/plain
Schema: string
Schema: string
Create a new badge or update an existing badge
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/organizations/badgesapplication/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
description | string | Yes | A description of the milestone achieved, often including criteria for receiving this recognition. |
id | string (uuid) | No | Existing badge ID for updates; omit on create. |
image_url | string (uri) | Yes | URL to the badge image |
label | string | Yes | unique identifier for the badge ( auto generated ) |
name | string | Yes | Concise descriptor for the badge or certificate. |
org_id | string (uuid) | Yes | The ID of the organization in which this badge is available. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
No description provided.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
created_at | string (date-time) | Yes | Timestamp when the resource was created. |
deleted_at | string (date-time) | Yes | Timestamp when the resource was deleted, if applicable |
description | string | Yes | A description of the milestone achieved, often including criteria for receiving this recognition. |
id | string (uuid) | Yes | A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. |
image_url | string (uri) | Yes | URL to the badge image |
label | string | Yes | unique identifier for the badge ( auto generated ) |
name | string | Yes | Concise descriptor for the badge or certificate. |
org_id | string (uuid) | Yes | The ID of the organization in which this badge is available . |
updated_at | string (date-time) | Yes | Timestamp when the resource was updated. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get a badge by its ID
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/organizations/badges/{id}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | Unique identifier |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
No description provided.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
created_at | string (date-time) | Yes | Timestamp when the resource was created. |
deleted_at | string (date-time) | Yes | Timestamp when the resource was deleted, if applicable |
description | string | Yes | A description of the milestone achieved, often including criteria for receiving this recognition. |
id | string (uuid) | Yes | A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. |
image_url | string (uri) | Yes | URL to the badge image |
label | string | Yes | unique identifier for the badge ( auto generated ) |
name | string | Yes | Concise descriptor for the badge or certificate. |
org_id | string (uuid) | Yes | The ID of the organization in which this badge is available . |
updated_at | string (date-time) | Yes | Timestamp when the resource was updated. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Delete a badge by its ID
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/organizations/badges/{id}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | Unique identifier |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get all invitations for the organization
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/organizations/invitationsReturned data
Status codes, content types, and response schemas returned by this endpoint.
No description provided.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
data | array of object | Yes | List of invitations |
total | integer | Yes | Total number of invitations available |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Create a new invitation for the organization
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/organizations/invitationsapplication/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
description | string | Yes | Description of the invitation. |
emails | array of string | Yes | The emails of the invitation. |
expires_at | string (date-time) | No | Timestamp when the invitation expires, if applicable. |
id | string (uuid) | No | Existing invitation ID for updates; omit on create. |
is_default | boolean | No | Indicates whether the invitation is a default invitation (open invite). |
name | string | Yes | Name of the invitation. |
org_id | string (uuid) | Yes | ID of the organization to which the user is invited. |
owner_id | string (uuid) | No | ID of the user who created the invitation. |
quota | integer | No | Quota for the invitation. |
roles | array of string | Yes | The roles of the invitation. |
status | string | Yes | Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later. |
teams | array of string | Yes | The teams of the invitation. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
No description provided.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
accepted_by | array of string | Yes | List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet |
created_at | string (date-time) | Yes | Timestamp when the invitation was created |
deleted_at | string (date-time) | Yes | Timestamp when the invitation was deleted, if applicable |
description | string | Yes | Description of the invitation, which can be used to provide additional information about the invitation, null or empty string means the invitation does not have a description |
emails | array of string | Yes | The emails of the invitation. |
expires_at | string (date-time) | No | Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire |
id | string (uuid) | Yes | Unique identifier for the invitation , is also used as the invitation code |
is_default | boolean | No | Indicates whether the invitation is a default invitation (open invite), which can be used to assign users when signing up from fqdn or custom domain, a organization can only have one default invitation |
name | string | Yes | Name of the invitation, which can be used to identify the invitation, required and cant be empty string, |
org_id | string (uuid) | Yes | ID of the organization to which the user is invited |
owner_id | string (uuid) | Yes | ID of the user who created the invitation, this is used to track who created the invitation and can be used for auditing purposes |
quota | integer | No | Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota |
roles | array of string | Yes | The roles of the invitation. |
status | string | Yes | Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later. |
teams | array of string | Yes | The teams of the invitation. |
updated_at | string (date-time) | Yes | Timestamp when the invitation was last updated |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get an invitation by ID
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/organizations/invitations/{invitationId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
invitationId | string | Yes | The ID of the invitation |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
No description provided.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
accepted_by | array of string | Yes | List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet |
created_at | string (date-time) | Yes | Timestamp when the invitation was created |
deleted_at | string (date-time) | Yes | Timestamp when the invitation was deleted, if applicable |
description | string | Yes | Description of the invitation, which can be used to provide additional information about the invitation, null or empty string means the invitation does not have a description |
emails | array of string | Yes | The emails of the invitation. |
expires_at | string (date-time) | No | Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire |
id | string (uuid) | Yes | Unique identifier for the invitation , is also used as the invitation code |
is_default | boolean | No | Indicates whether the invitation is a default invitation (open invite), which can be used to assign users when signing up from fqdn or custom domain, a organization can only have one default invitation |
name | string | Yes | Name of the invitation, which can be used to identify the invitation, required and cant be empty string, |
org_id | string (uuid) | Yes | ID of the organization to which the user is invited |
owner_id | string (uuid) | Yes | ID of the user who created the invitation, this is used to track who created the invitation and can be used for auditing purposes |
quota | integer | No | Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota |
roles | array of string | Yes | The roles of the invitation. |
status | string | Yes | Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later. |
teams | array of string | Yes | The teams of the invitation. |
updated_at | string (date-time) | Yes | Timestamp when the invitation was last updated |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Update an existing invitation
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/organizations/invitations/{invitationId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
invitationId | string | Yes | The ID of the invitation |
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
description | string | Yes | Description of the invitation. |
emails | array of string | Yes | The emails of the invitation. |
expires_at | string (date-time) | No | Timestamp when the invitation expires, if applicable. |
id | string (uuid) | No | Existing invitation ID for updates; omit on create. |
is_default | boolean | No | Indicates whether the invitation is a default invitation (open invite). |
name | string | Yes | Name of the invitation. |
org_id | string (uuid) | Yes | ID of the organization to which the user is invited. |
owner_id | string (uuid) | No | ID of the user who created the invitation. |
quota | integer | No | Quota for the invitation. |
roles | array of string | Yes | The roles of the invitation. |
status | string | Yes | Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later. |
teams | array of string | Yes | The teams of the invitation. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
No description provided.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
accepted_by | array of string | Yes | List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet |
created_at | string (date-time) | Yes | Timestamp when the invitation was created |
deleted_at | string (date-time) | Yes | Timestamp when the invitation was deleted, if applicable |
description | string | Yes | Description of the invitation, which can be used to provide additional information about the invitation, null or empty string means the invitation does not have a description |
emails | array of string | Yes | The emails of the invitation. |
expires_at | string (date-time) | No | Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire |
id | string (uuid) | Yes | Unique identifier for the invitation , is also used as the invitation code |
is_default | boolean | No | Indicates whether the invitation is a default invitation (open invite), which can be used to assign users when signing up from fqdn or custom domain, a organization can only have one default invitation |
name | string | Yes | Name of the invitation, which can be used to identify the invitation, required and cant be empty string, |
org_id | string (uuid) | Yes | ID of the organization to which the user is invited |
owner_id | string (uuid) | Yes | ID of the user who created the invitation, this is used to track who created the invitation and can be used for auditing purposes |
quota | integer | No | Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota |
roles | array of string | Yes | The roles of the invitation. |
status | string | Yes | Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later. |
teams | array of string | Yes | The teams of the invitation. |
updated_at | string (date-time) | Yes | Timestamp when the invitation was last updated |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Delete an invitation by ID
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/organizations/invitations/{invitationId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
invitationId | string | Yes | The ID of the invitation |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Accept an invitation by ID
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/organizations/invitations/{invitationId}/acceptPath parameters
| Name | Type | Required | Description |
|---|---|---|---|
invitationId | string | Yes | The ID of the invitation |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
No description provided.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
accepted_by | array of string | Yes | List of user ids that have already accepted the invitation, null or empty string means the invitation has not been used yet |
created_at | string (date-time) | Yes | Timestamp when the invitation was created |
deleted_at | string (date-time) | Yes | Timestamp when the invitation was deleted, if applicable |
description | string | Yes | Description of the invitation, which can be used to provide additional information about the invitation, null or empty string means the invitation does not have a description |
emails | array of string | Yes | The emails of the invitation. |
expires_at | string (date-time) | No | Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire |
id | string (uuid) | Yes | Unique identifier for the invitation , is also used as the invitation code |
is_default | boolean | No | Indicates whether the invitation is a default invitation (open invite), which can be used to assign users when signing up from fqdn or custom domain, a organization can only have one default invitation |
name | string | Yes | Name of the invitation, which can be used to identify the invitation, required and cant be empty string, |
org_id | string (uuid) | Yes | ID of the organization to which the user is invited |
owner_id | string (uuid) | Yes | ID of the user who created the invitation, this is used to track who created the invitation and can be used for auditing purposes |
quota | integer | No | Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota |
roles | array of string | Yes | The roles of the invitation. |
status | string | Yes | Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later. |
teams | array of string | Yes | The teams of the invitation. |
updated_at | string (date-time) | Yes | Timestamp when the invitation was last updated |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Import Design
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/pattern/importmultipart/form-data
Schema: object
| 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
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
message | string | No | No description provided. |
text/plain
Schema: string
Schema: string
Share a resource
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/resource/{resourceType}/share/{resourceId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
resourceType | string | Yes | No description provided. |
resourceId | string | Yes | No description provided. |
application/json
Schema: object
Schema: object
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
Schema: object
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get resource access actors by type
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/resource/{resourceType}/share/{resourceId}/{actorType}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
resourceType | string | Yes | No description provided. |
resourceId | string | Yes | No description provided. |
actorType | string | Yes | No description provided. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
users | array of object | No | The users of the resourceaccessactorsresponse. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get public users
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/usersQuery 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
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| 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. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get all workspaces
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.meshery.io/api/workspacesMeshery Cloud staging server URL
https://staging-cloud.meshery.io/api/workspacesMeshery Cloud development server URL (controlled via PORT environment variable)
http://localhost:9876/api/workspacesQuery parameters
| Name | Type | Required | Description |
|---|---|---|---|
search | string | No | Get responses that match search param value |
order | string | No | Get ordered responses |
page | string | No | Get responses by page |
pagesize | string | No | Get responses by pagesize |
filter | string | No | JSON-encoded filter string used for assignment and soft-delete filters. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
page | integer | No | No description provided. |
page_size | integer | No | No description provided. |
total_count | integer | No | No description provided. |
workspaces | array of object | No | The workspaces of the workspacepage. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Create a workspace
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.meshery.io/api/workspacesMeshery Cloud staging server URL
https://staging-cloud.meshery.io/api/workspacesMeshery Cloud development server URL (controlled via PORT environment variable)
http://localhost:9876/api/workspacesapplication/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
description | string | No | Description of the workspace. |
name | string | Yes | Name of the workspace. |
organization_id | string (uuid) | Yes | Organization ID. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
created_at | string (date-time) | No | Timestamp when the resource was created. |
deleted_at | string (date-time) | No | Timestamp when the resource was deleted. |
description | string | No | No description provided. |
id | string (uuid) | No | No description provided. |
metadata | object | No | No description provided. |
name | string | No | No description provided. |
organization_id | string (uuid) | No | Workspace organization ID |
owner | string | No | No description provided. |
updated_at | string (date-time) | No | Timestamp when the resource was updated. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get a workspace by ID
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.meshery.io/api/workspaces/{workspaceId}Meshery Cloud staging server URL
https://staging-cloud.meshery.io/api/workspaces/{workspaceId}Meshery Cloud development server URL (controlled via PORT environment variable)
http://localhost:9876/api/workspaces/{workspaceId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
workspaceId | string (uuid) | Yes | Workspace ID |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
created_at | string (date-time) | No | Timestamp when the resource was created. |
deleted_at | string (date-time) | No | Timestamp when the resource was deleted. |
description | string | No | No description provided. |
id | string (uuid) | No | No description provided. |
metadata | object | No | No description provided. |
name | string | No | No description provided. |
organization_id | string (uuid) | No | Workspace organization ID |
owner | string | No | No description provided. |
updated_at | string (date-time) | No | Timestamp when the resource was updated. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Update a workspace
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.meshery.io/api/workspaces/{workspaceId}Meshery Cloud staging server URL
https://staging-cloud.meshery.io/api/workspaces/{workspaceId}Meshery Cloud development server URL (controlled via PORT environment variable)
http://localhost:9876/api/workspaces/{workspaceId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
workspaceId | string (uuid) | Yes | Workspace ID |
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
description | string | No | Description of the workspace. |
name | string | No | Name of the workspace. |
organization_id | string (uuid) | Yes | Organization ID. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
created_at | string (date-time) | No | Timestamp when the resource was created. |
deleted_at | string (date-time) | No | Timestamp when the resource was deleted. |
description | string | No | No description provided. |
id | string (uuid) | No | No description provided. |
metadata | object | No | No description provided. |
name | string | No | No description provided. |
organization_id | string (uuid) | No | Workspace organization ID |
owner | string | No | No description provided. |
updated_at | string (date-time) | No | Timestamp when the resource was updated. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Delete a workspace
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.meshery.io/api/workspaces/{workspaceId}Meshery Cloud staging server URL
https://staging-cloud.meshery.io/api/workspaces/{workspaceId}Meshery Cloud development server URL (controlled via PORT environment variable)
http://localhost:9876/api/workspaces/{workspaceId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
workspaceId | string (uuid) | Yes | Workspace ID |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get designs assigned to a workspace
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.meshery.io/api/workspaces/{workspaceId}/designsMeshery Cloud staging server URL
https://staging-cloud.meshery.io/api/workspaces/{workspaceId}/designsMeshery Cloud development server URL (controlled via PORT environment variable)
http://localhost:9876/api/workspaces/{workspaceId}/designsPath parameters
| Name | Type | Required | Description |
|---|---|---|---|
workspaceId | string (uuid) | Yes | Workspace ID |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
search | string | No | Get responses that match search param value |
order | string | No | Get ordered responses |
page | string | No | Get responses by page |
pagesize | string | No | Get responses by pagesize |
filter | string | No | JSON-encoded filter string used for assignment and soft-delete filters. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
designs | array of object | No | The designs of the mesherydesignpage. |
page | integer | No | No description provided. |
page_size | integer | No | No description provided. |
total_count | integer | No | No description provided. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Assign a design to a workspace
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.meshery.io/api/workspaces/{workspaceId}/designs/{designId}Meshery Cloud staging server URL
https://staging-cloud.meshery.io/api/workspaces/{workspaceId}/designs/{designId}Meshery Cloud development server URL (controlled via PORT environment variable)
http://localhost:9876/api/workspaces/{workspaceId}/designs/{designId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
workspaceId | string (uuid) | Yes | Workspace ID |
designId | string (uuid) | Yes | Design ID |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
page | integer | No | No description provided. |
page_size | integer | No | No description provided. |
total_count | integer | No | No description provided. |
workspacesDesignsMapping | array of object | No | The workspaces designs mapping of the workspacesdesignsmappingpage. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Unassign a design from a workspace
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.meshery.io/api/workspaces/{workspaceId}/designs/{designId}Meshery Cloud staging server URL
https://staging-cloud.meshery.io/api/workspaces/{workspaceId}/designs/{designId}Meshery Cloud development server URL (controlled via PORT environment variable)
http://localhost:9876/api/workspaces/{workspaceId}/designs/{designId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
workspaceId | string (uuid) | Yes | Workspace ID |
designId | string (uuid) | Yes | Design ID |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get environments assigned to a workspace
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.meshery.io/api/workspaces/{workspaceId}/environmentsMeshery Cloud staging server URL
https://staging-cloud.meshery.io/api/workspaces/{workspaceId}/environmentsMeshery Cloud development server URL (controlled via PORT environment variable)
http://localhost:9876/api/workspaces/{workspaceId}/environmentsPath parameters
| Name | Type | Required | Description |
|---|---|---|---|
workspaceId | string (uuid) | Yes | Workspace ID |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
search | string | No | Get responses that match search param value |
order | string | No | Get ordered responses |
page | string | No | Get responses by page |
pagesize | string | No | Get responses by pagesize |
filter | string | No | JSON-encoded filter string used for assignment and soft-delete filters. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
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. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Assign an environment to a workspace
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.meshery.io/api/workspaces/{workspaceId}/environments/{environmentId}Meshery Cloud staging server URL
https://staging-cloud.meshery.io/api/workspaces/{workspaceId}/environments/{environmentId}Meshery Cloud development server URL (controlled via PORT environment variable)
http://localhost:9876/api/workspaces/{workspaceId}/environments/{environmentId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
workspaceId | string (uuid) | Yes | Workspace ID |
environmentId | string (uuid) | Yes | Environment ID |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
page | integer | No | No description provided. |
page_size | integer | No | No description provided. |
total_count | integer | No | No description provided. |
workspacesEnvironmentsMapping | array of object | No | The workspaces environments mapping of the workspacesenvironmentsmappingpage. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Unassign an environment from a workspace
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.meshery.io/api/workspaces/{workspaceId}/environments/{environmentId}Meshery Cloud staging server URL
https://staging-cloud.meshery.io/api/workspaces/{workspaceId}/environments/{environmentId}Meshery Cloud development server URL (controlled via PORT environment variable)
http://localhost:9876/api/workspaces/{workspaceId}/environments/{environmentId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
workspaceId | string (uuid) | Yes | Workspace ID |
environmentId | string (uuid) | Yes | Environment ID |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get workspace events
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/api/workspaces/{workspaceId}/eventsPath parameters
| Name | Type | Required | Description |
|---|---|---|---|
workspaceId | string (uuid) | Yes | Workspace ID |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
page | string | No | Get responses by page |
pagesize | string | No | Get responses by pagesize |
search | string | No | Get responses that match search param value |
order | string | No | Get ordered responses |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
data | array of object | No | The data of the eventspage. |
page | integer | No | No description provided. |
page_size | integer | No | No description provided. |
total_count | integer | No | No description provided. |
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
error | string | No | The error of the errorresponse. |
Get teams assigned to a workspace
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.meshery.io/api/workspaces/{workspaceId}/teamsMeshery Cloud staging server URL
https://staging-cloud.meshery.io/api/workspaces/{workspaceId}/teamsMeshery Cloud development server URL (controlled via PORT environment variable)
http://localhost:9876/api/workspaces/{workspaceId}/teamsPath parameters
| Name | Type | Required | Description |
|---|---|---|---|
workspaceId | string (uuid) | Yes | Workspace ID |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
search | string | No | Get responses that match search param value |
order | string | No | Get ordered responses |
page | string | No | Get responses by page |
pagesize | string | No | Get responses by pagesize |
filter | string | No | JSON-encoded filter string used for assignment and soft-delete filters. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| 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. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Assign a team to a workspace
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.meshery.io/api/workspaces/{workspaceId}/teams/{teamId}Meshery Cloud staging server URL
https://staging-cloud.meshery.io/api/workspaces/{workspaceId}/teams/{teamId}Meshery Cloud development server URL (controlled via PORT environment variable)
http://localhost:9876/api/workspaces/{workspaceId}/teams/{teamId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
workspaceId | string (uuid) | Yes | Workspace ID |
teamId | string (uuid) | Yes | Team ID |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
page | integer | No | No description provided. |
page_size | integer | No | No description provided. |
total_count | integer | No | No description provided. |
workspacesTeamsMapping | array of object | No | The workspaces teams mapping of the workspacesteamsmappingpage. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Unassign a team from a workspace
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.meshery.io/api/workspaces/{workspaceId}/teams/{teamId}Meshery Cloud staging server URL
https://staging-cloud.meshery.io/api/workspaces/{workspaceId}/teams/{teamId}Meshery Cloud development server URL (controlled via PORT environment variable)
http://localhost:9876/api/workspaces/{workspaceId}/teams/{teamId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
workspaceId | string (uuid) | Yes | Workspace ID |
teamId | string (uuid) | Yes | Team ID |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get views assigned to a workspace
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.meshery.io/api/workspaces/{workspaceId}/viewsMeshery Cloud staging server URL
https://staging-cloud.meshery.io/api/workspaces/{workspaceId}/viewsMeshery Cloud development server URL (controlled via PORT environment variable)
http://localhost:9876/api/workspaces/{workspaceId}/viewsPath parameters
| Name | Type | Required | Description |
|---|---|---|---|
workspaceId | string (uuid) | Yes | Workspace ID |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
search | string | No | Get responses that match search param value |
order | string | No | Get ordered responses |
page | string | No | Get responses by page |
pagesize | string | No | Get responses by pagesize |
filter | string | No | JSON-encoded filter string used for assignment and soft-delete filters. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
page | integer | No | No description provided. |
page_size | integer | No | No description provided. |
total_count | integer | No | No description provided. |
views | array of object | No | The views of the mesheryviewpage. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Assign a view to a workspace
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.meshery.io/api/workspaces/{workspaceId}/views/{viewId}Meshery Cloud staging server URL
https://staging-cloud.meshery.io/api/workspaces/{workspaceId}/views/{viewId}Meshery Cloud development server URL (controlled via PORT environment variable)
http://localhost:9876/api/workspaces/{workspaceId}/views/{viewId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
workspaceId | string (uuid) | Yes | Workspace ID |
viewId | string (uuid) | Yes | View ID |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
page | integer | No | No description provided. |
page_size | integer | No | No description provided. |
total_count | integer | No | No description provided. |
workspacesViewsMapping | array of object | No | The workspaces views mapping of the workspacesviewsmappingpage. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Unassign a view from a workspace
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.meshery.io/api/workspaces/{workspaceId}/views/{viewId}Meshery Cloud staging server URL
https://staging-cloud.meshery.io/api/workspaces/{workspaceId}/views/{viewId}Meshery Cloud development server URL (controlled via PORT environment variable)
http://localhost:9876/api/workspaces/{workspaceId}/views/{viewId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
workspaceId | string (uuid) | Yes | Workspace ID |
viewId | string (uuid) | Yes | View ID |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Create a new event
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/eventsapplication/json
Schema: object
Schema: object
Returned data
Status codes, content types, and response schemas returned by this endpoint.
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Bulk delete events
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/events/deleteapplication/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
ids | array of string (uuid) | Yes | The ids of the bulkdeleterequest. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
deleted | array of string (uuid) | No | No description provided. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Bulk update event status
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/events/statusapplication/json
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
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
updated | array of string (uuid) | No | No description provided. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Delete a single event
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/events/{id}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | ID of the event to delete |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Update status of a single event
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Layer5 Cloud default URL
https://cloud.layer5.io/events/{id}/statusPath parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | ID of the event |
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
status | string | Yes | Current status of the resource. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
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. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get schedules
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.layer5.io/user/schedulesMeshery Cloud staging server URL
https://staging-cloud.layer5.io/user/schedulesMeshery Cloud development server URL
http://localhost:9876/user/schedulesQuery parameters
| Name | Type | Required | Description |
|---|---|---|---|
page | string | No | Get responses by page |
pagesize | string | No | Get responses by pagesize |
search | string | No | Get responses that match search param value |
order | string | No | Get ordered responses |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
page | integer | Yes | Current page number (zero-based). |
page_size | integer | Yes | Number of schedules per page. |
total_count | integer | Yes | Total number of schedules across all pages. |
schedules | array of object | Yes | The schedules of the schedulepage. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Create or update schedule
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.layer5.io/user/schedulesMeshery Cloud staging server URL
https://staging-cloud.layer5.io/user/schedulesMeshery Cloud development server URL
http://localhost:9876/user/schedulesapplication/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | No | Unique identifier for the schedule. |
name | string | Yes | Human-readable name for the schedule. |
user_id | string (uuid) | Yes | UUID of the user who owns this schedule. |
cron_expression | string | Yes | Cron expression defining the schedule’s recurrence (e.g. “0 0 * * *” for daily at midnight). |
created_at | string (date-time) | No | Timestamp when the resource was created. |
updated_at | string (date-time) | No | Timestamp when the resource was updated. |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | No | Unique identifier for the schedule. |
name | string | Yes | Human-readable name for the schedule. |
user_id | string (uuid) | Yes | UUID of the user who owns this schedule. |
cron_expression | string | Yes | Cron expression defining the schedule’s recurrence (e.g. “0 0 * * *” for daily at midnight). |
created_at | string (date-time) | No | Timestamp when the resource was created. |
updated_at | string (date-time) | No | Timestamp when the resource was updated. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Get schedule by ID
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.layer5.io/user/schedules/{id}Meshery Cloud staging server URL
https://staging-cloud.layer5.io/user/schedules/{id}Meshery Cloud development server URL
http://localhost:9876/user/schedules/{id}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | Schedule ID |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | No | Unique identifier for the schedule. |
name | string | Yes | Human-readable name for the schedule. |
user_id | string (uuid) | Yes | UUID of the user who owns this schedule. |
cron_expression | string | Yes | Cron expression defining the schedule’s recurrence (e.g. “0 0 * * *” for daily at midnight). |
created_at | string (date-time) | No | Timestamp when the resource was created. |
updated_at | string (date-time) | No | Timestamp when the resource was updated. |
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
Delete schedule
Base URLs
Substitute your own Layer5 Cloud hostname when you are working against a hosted or self-managed instance.
Meshery Cloud production server URL
https://cloud.layer5.io/user/schedules/{id}Meshery Cloud staging server URL
https://staging-cloud.layer5.io/user/schedules/{id}Meshery Cloud development server URL
http://localhost:9876/user/schedules/{id}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | Schedule ID |
Returned data
Status codes, content types, and response schemas returned by this endpoint.
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string
text/plain
Schema: string
Schema: string