Layer5 Cloud (v0.8.42)

Download OpenAPI specification:Download

Documentation for Layer5 Cloud REST APIs

capabilities

APIs for remote provider capablities

Capabilities Deprecated

Get available capabilities for logged in user

query Parameters

os	string user's os
playground	string Is playground mode

Responses

Response samples

200

Content type

application/json

{"provider_type": "string",
"package_version": "string",
"package_url": "string",
"provider_name": "string",
"provider_description": ["string"
],
"extensions": {"navigator": [{"title": "string",
"on_click_callback": 0,
"href": {"uri": "http://example.com",
"external": true
},
"component": "string",
"icon": "string",
"link": "string",
"show": true,
"isBeta": true,
"type": "string",
"allowedTo": { }
}
],
"user_prefs": [{"component": "string",
"type": "string"
}
],
"graphql": [{"component": "string",
"path": "string",
"type": "string"
}
],
"account": [{"title": "string",
"on_click_callback": 0,
"href": {"uri": "http://example.com",
"external": true
},
"component": "string",
"link": "string",
"show": true,
"type": "string"
}
],
"collaborator": [{"component": "string",
"type": "string"
}
]
},
"capabilities": {"feature": "string",
"endpoint": "string"
},
"restrictedAccess": {"isMesheryUIRestricted": true,
"allowedComponents": {"navigator": { },
"header": { }
}
}
}

Capabilities By server version

Get available capabilities for logged in user

path Parameters

meshery-version

required

string

meshery version

query Parameters

os	string user's os
playground	string Is playground mode

Responses

Response samples

200

Content type

application/json

{"provider_type": "string",
"package_version": "string",
"package_url": "string",
"provider_name": "string",
"provider_description": ["string"
],
"extensions": {"navigator": [{"title": "string",
"on_click_callback": 0,
"href": {"uri": "http://example.com",
"external": true
},
"component": "string",
"icon": "string",
"link": "string",
"show": true,
"isBeta": true,
"type": "string",
"allowedTo": { }
}
],
"user_prefs": [{"component": "string",
"type": "string"
}
],
"graphql": [{"component": "string",
"path": "string",
"type": "string"
}
],
"account": [{"title": "string",
"on_click_callback": 0,
"href": {"uri": "http://example.com",
"external": true
},
"component": "string",
"link": "string",
"show": true,
"type": "string"
}
],
"collaborator": [{"component": "string",
"type": "string"
}
]
},
"capabilities": {"feature": "string",
"endpoint": "string"
},
"restrictedAccess": {"isMesheryUIRestricted": true,
"allowedComponents": {"navigator": { },
"header": { }
}
}
}

catalog

Catalog contains published designs, filters and other artifacts

Get Catalog Content

Get catalog content by type

path Parameters

type

required

string (catalogContentType)

Enum: "pattern" "filter"

Catalog content type

query Parameters

page	string Get responses by page
pagesize	string Get responses by pagesize
search	string Get responses that match search param value
order	string Get ordered responses
type	string Filter catalog data based on type of content e.g (deployment, workloads, scaling...) multiple params can be passed
technology	string Filter catalog data based on technology(compatibility) of content e.g (kubernetes, istio...) multiple params can be passed
metrics	string Include metrics associated with the designs.
class	string Filter catalog items based on their support class. Specify one or more classes per request as needed. Example: 'official' and 'verified'
userid	string Filter catalog items by user ID. Pass multiple user IDs to fetch content for several users simultaneously.
orgID required	string User's organization ID

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"filters": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"filter_file": "string",
"name": "string",
"location": {"property1": "string",
"property2": "string"
},
"visibility": "string",
"catalog_data": {"property1": "string",
"property2": "string"
},
"config": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Publish Catalog Content

Sets the visibility of catalog content to published and sets CatalogData (if called by ADMIN or CURATOR), otherwise it pushes the request to CatalogRequests Table

Authorizations:

jwt

path Parameters

type

required

string (catalogContentType)

Enum: "pattern" "filter"

Catalog content type

Request Body schema: application/json
required

Body for publishing catalog

id

string <uuid> (id)

catalog_type

string (catalogContentType)

Enum: "pattern" "filter"

Catalog type (pattern / filter)

object (map_object)

property name*

additional property

string

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"catalog_type": "pattern",
"catalog_data": {"property1": "string",
"property2": "string"
}
}

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"content_id": "713e4c61-5a69-43fb-a600-2e2699462e14",
"content_name": "string",
"content_type": "pattern",
"first_name": "string",
"last_name": "string",
"user": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "string",
"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"avatar_url": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
},
"email": "user@example.com",
"status": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Unpublish Catalog Content

Sets the visibility of catalog content to private and removes the content from website (if called by ADMIN or CURATOR), otherwise rejects the request

Authorizations:

jwt

path Parameters

type

required

string (catalogContentType)

Enum: "pattern" "filter"

Catalog content type

Request Body schema: application/json
required

Body for publishing catalog

id

string <uuid> (id)

catalog_type

string (catalogContentType)

Enum: "pattern" "filter"

Catalog type (pattern / filter)

object (map_object)

property name*

additional property

string

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"catalog_type": "pattern",
"catalog_data": {"property1": "string",
"property2": "string"
}
}

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"content_id": "713e4c61-5a69-43fb-a600-2e2699462e14",
"content_name": "string",
"content_type": "pattern",
"first_name": "string",
"last_name": "string",
"user": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "string",
"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"avatar_url": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
},
"email": "user@example.com",
"status": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Approve Catalog Request

Authorizations:

jwt

Request Body schema: application/json
required

Body for publishing catalog

id

string <uuid> (id)

catalog_type

string (catalogContentType)

Enum: "pattern" "filter"

Catalog type (pattern / filter)

object (map_object)

property name*

additional property

string

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"catalog_type": "pattern",
"catalog_data": {"property1": "string",
"property2": "string"
}
}

Get supported catalog classes

Authorizations:

jwt

Responses

Response samples

200

Content type

application/json

"string"

Deny Catalog Request

Authorizations:

jwt

Request Body schema: application/json
required

Body for publishing catalog

id

string <uuid> (id)

catalog_type

string (catalogContentType)

Enum: "pattern" "filter"

Catalog type (pattern / filter)

object (map_object)

property name*

additional property

string

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"catalog_type": "pattern",
"catalog_data": {"property1": "string",
"property2": "string"
}
}

Catalog Request

Get all catalog requests (approved, denied or pending) in a paginated manner

Authorizations:

jwt

query Parameters

page	string Get responses by page
pagesize	string Get responses by pagesize
search	string Get responses that match search param value
order	string Get ordered responses
	object Filter for catalog requests

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"resultType": "string",
"catalogRequests": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"content_id": "713e4c61-5a69-43fb-a600-2e2699462e14",
"content_name": "string",
"content_type": "pattern",
"first_name": "string",
"last_name": "string",
"user": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "string",
"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"avatar_url": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
},
"email": "user@example.com",
"status": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

collaboration

APIs for collaboration

Collaboration

Authorizations:

jwt

Responses

content

APIs for content (designs, patterns, filters)

Upsert Pattern resource

It will insert the pattern resource if not present else it will update the matching entry

Authorizations:

jwt

Request Body schema: application/json
required

Body for upserting meshery pattern resource

id	string <uuid> (id)
user_id	string <uuid> (id)
name	string (text) Name
namepace	string (text) Namespace
type	string (text) Type
oam_type	string (text) OAM type
deleted	boolean
created_at	string <date-time> (time)
updated_at	string <date-time> (time)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"name": "string",
"namepace": "string",
"type": "string",
"oam_type": "string",
"deleted": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"name": "string",
"namepace": "string",
"type": "string",
"oam_type": "string",
"deleted": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Get Pattern resources

Get paginated pattern resources

Authorizations:

jwt

query Parameters

page	string Get responses by page
pagesize	string Get responses by pagesize
search	string Get responses that match search param value
order	string Get ordered responses
namespace	string Namespace
type	string Type
oamType	string OAM type
name	string Name of the resource
workspaceid required	string <uuid> (id) Name

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"resultType": "string",
"resources": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"name": "string",
"namepace": "string",
"type": "string",
"oam_type": "string",
"deleted": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Pattern Resource by ID

Get Pattern Resource By ID

Authorizations:

jwt

path Parameters

id

required

string <uuid> (id)

Unique identifier

Responses

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"name": "string",
"namepace": "string",
"type": "string",
"oam_type": "string",
"deleted": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete pattern resource

Delete pattern resource associated with id

Authorizations:

jwt

path Parameters

id

required

string <uuid> (id)

Unique identifier

Responses

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"name": "string",
"namepace": "string",
"type": "string",
"oam_type": "string",
"deleted": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Upsert pattern source content

Upserts only pattern source content

Authorizations:

jwt

path Parameters

id

required

string <uuid> (id)

Unique identifier

Request Body schema: text/plain
required

Body for upserting meshery pattern source content

string <byte> (source_content)

Source content

Responses

Upsert Pattern

It will insert the pattern if not present else it will update the matching entry

Authorizations:

jwt

Request Body schema: application/json
required

Body for upserting meshery pattern

url

string (text)

path

string (text)

save

boolean

object (mesheryPattern)

id

string <uuid> (id)

user_id

string <uuid> (id)

object (userSummary)

id	string <uuid> (id)
user_id	string (user_id) user's email or username
email	string <email> (email) email
first_name	string (text) First Name
last_name	string (text) Last Name
avatar_url	string (avatar_url) Link for profile picture
created_at	string <date-time> (time)
updated_at	string <date-time> (time)
deleted_at	string <date-time> (time)

pattern_file

string (text)

Pattern file

name

string (text)

Pattern Name

object (map_object)

property name*

additional property

string

visibility

string (text)

source_type

string (text)

Source type (K8s manifest, Helm chart, Docker compose, Design)

source_content

string <byte>

Source content

object (map_object)

property name*

additional property

string

created_at

string <date-time> (time)

updated_at

string <date-time> (time)

Responses

Request samples

Payload

Content type

application/json

{"url": "string",
"path": "string",
"save": true,
"pattern_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"user": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "string",
"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"avatar_url": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
},
"pattern_file": "string",
"name": "string",
"location": {"property1": "string",
"property2": "string"
},
"visibility": "string",
"source_type": "string",
"source_content": "string",
"catalog_data": {"property1": "string",
"property2": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"user": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "string",
"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"avatar_url": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
},
"pattern_file": "string",
"name": "string",
"location": {"property1": "string",
"property2": "string"
},
"visibility": "string",
"source_type": "string",
"source_content": "string",
"catalog_data": {"property1": "string",
"property2": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]

Get Patterns

Get paginated patterns

Authorizations:

jwt

query Parameters

page	string Get responses by page
pagesize	string Get responses by pagesize
search	string Get responses that match search param value
order	string Get ordered responses
visibility	string Get responses based on visibility - private, public or published
metrics	string Include metrics associated with the designs.
orgID required	string User's organization ID
workspaceid required	string <uuid> (id) Workspace ID
user_id	string UUID of User. Pass user_id for fetching public and published designs

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"resultType": "string",
"patterns": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"user": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "string",
"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"avatar_url": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
},
"pattern_file": "string",
"name": "string",
"location": {"property1": "string",
"property2": "string"
},
"visibility": "string",
"source_type": "string",
"source_content": "string",
"catalog_data": {"property1": "string",
"property2": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Delete patterns

Delete patterns with the provided ids

Authorizations:

jwt

Request Body schema: application/json
required

Body for pattern delete request

Array of objects (deletePatternModel)

Array

id	string <uuid> (id)
name	string (text) Pattern name

Responses

Request samples

Payload

Content type

application/json

{"patterns": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
]
}

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"user": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "string",
"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"avatar_url": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
},
"pattern_file": "string",
"name": "string",
"location": {"property1": "string",
"property2": "string"
},
"visibility": "string",
"source_type": "string",
"source_content": "string",
"catalog_data": {"property1": "string",
"property2": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Get pattern by ID

Authorizations:

jwt

path Parameters

id

required

string <uuid> (id)

Unique identifier

query Parameters

metrics

string

Include metrics associated with the designs.

Responses

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"user": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "string",
"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"avatar_url": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
},
"pattern_file": "string",
"name": "string",
"location": {"property1": "string",
"property2": "string"
},
"visibility": "string",
"source_type": "string",
"source_content": "string",
"catalog_data": {"property1": "string",
"property2": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete pattern by ID

Delete pattern associated with ID

Authorizations:

jwt

path Parameters

id

required

string <uuid> (id)

Unique identifier

Responses

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"user": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "string",
"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"avatar_url": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
},
"pattern_file": "string",
"name": "string",
"location": {"property1": "string",
"property2": "string"
},
"visibility": "string",
"source_type": "string",
"source_content": "string",
"catalog_data": {"property1": "string",
"property2": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Clone pattern

Clone pattern associated with ID

Authorizations:

jwt

path Parameters

id

required

string <uuid> (id)

Unique identifier

Request Body schema: application/json
required

Body for cloning design

name

required

string

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Upsert Filter

It will insert the filter if not present else it will update the matching entry

Authorizations:

jwt

Request Body schema: application/json
required

Body for upserting meshery filter

url

string (text)

path

string (text)

save

boolean

object (mesheryFilter)

id

string <uuid> (id)

user_id

string <uuid> (id)

filter_file

string <byte>

Filter file

name

string (text)

Filter Name

object (map_object)

property name*

additional property

string

visibility

string (text)

object (map_object)

property name*

additional property

string

config

string (text)

created_at

string <date-time> (time)

updated_at

string <date-time> (time)

Responses

Request samples

Payload

Content type

application/json

{"url": "string",
"path": "string",
"save": true,
"filter_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"filter_file": "string",
"name": "string",
"location": {"property1": "string",
"property2": "string"
},
"visibility": "string",
"catalog_data": {"property1": "string",
"property2": "string"
},
"config": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"filter_file": "string",
"name": "string",
"location": {"property1": "string",
"property2": "string"
},
"visibility": "string",
"catalog_data": {"property1": "string",
"property2": "string"
},
"config": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]

Get Filters

Get paginated filters

Authorizations:

jwt

query Parameters

page	string Get responses by page
pagesize	string Get responses by pagesize
search	string Get responses that match search param value
order	string Get ordered responses
visibility	string Get responses based on visibility - private, public or published

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"resultType": "string",
"filters": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"filter_file": "string",
"name": "string",
"location": {"property1": "string",
"property2": "string"
},
"visibility": "string",
"catalog_data": {"property1": "string",
"property2": "string"
},
"config": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Share Filter

Share filter design with others

Authorizations:

jwt

Request Body schema: application/json
required

Body for sharing design

emails required	Array of strings <email> (emails) [ items <email > ]
id required	string <uuid> (id)
content_type	string
share required	boolean

Responses

Request samples

Payload

Content type

application/json

{"emails": ["user@example.com"
],
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"content_type": "string",
"share": true
}

Filter file

Get the filter associated with the given filter id without any metadata

Authorizations:

jwt

path Parameters

id

required

string <uuid> (id)

Unique identifier

Responses

Response samples

200

Content type

application/json

"string"

Get filter by ID

Authorizations:

jwt

path Parameters

id

required

string <uuid> (id)

Unique identifier

Responses

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"filter_file": "string",
"name": "string",
"location": {"property1": "string",
"property2": "string"
},
"visibility": "string",
"catalog_data": {"property1": "string",
"property2": "string"
},
"config": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete filter by ID

Delete filter associated with ID

Authorizations:

jwt

path Parameters

id

required

string <uuid> (id)

Unique identifier

Responses

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"filter_file": "string",
"name": "string",
"location": {"property1": "string",
"property2": "string"
},
"visibility": "string",
"catalog_data": {"property1": "string",
"property2": "string"
},
"config": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Clone filter

Clone filter associated with ID

Authorizations:

jwt

path Parameters

id

required

string <uuid> (id)

Unique identifier

Request Body schema: application/json
required

Body for cloning design

name

required

string

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Upsert Application

It will insert the application if not present else it will update the matching entry

Authorizations:

jwt

Request Body schema: application/json
required

Body for upserting meshery application

url

string (text)

path

string (text)

save

boolean

object (mesheryApplication)

id

string <uuid> (id)

user_id

string <uuid> (id)

application_file

string (text)

Application file

name

string (text)

Pattern Name

object (map_object)

property name*

additional property

string

visibility

string (text)

source_type

string (text)

Source type (K8s manifest, Helm chart, Docker compose)

source_content

string <byte>

Source content

object (map_object)

property name*

additional property

string

created_at

string <date-time> (time)

updated_at

string <date-time> (time)

source_type

string (text)

Source type (K8s manifest, Helm chart, Docker compose)

Responses

Request samples

Payload

Content type

application/json

{"url": "string",
"path": "string",
"save": true,
"application_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"application_file": "string",
"name": "string",
"location": {"property1": "string",
"property2": "string"
},
"visibility": "string",
"source_type": "string",
"source_content": "string",
"catalog_data": {"property1": "string",
"property2": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"source_type": "string"
}

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"application_file": "string",
"name": "string",
"location": {"property1": "string",
"property2": "string"
},
"visibility": "string",
"source_type": "string",
"source_content": "string",
"catalog_data": {"property1": "string",
"property2": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]

Get Applications

Get paginated applications

Authorizations:

jwt

query Parameters

page	string Get responses by page
pagesize	string Get responses by pagesize
search	string Get responses that match search param value
order	string Get ordered responses

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"resultType": "string",
"applications": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"application_file": "string",
"name": "string",
"location": {"property1": "string",
"property2": "string"
},
"visibility": "string",
"source_type": "string",
"source_content": "string",
"catalog_data": {"property1": "string",
"property2": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Upsert application source content

Upserts only application source content

Authorizations:

jwt

path Parameters

id

required

string <uuid> (id)

Unique identifier

Request Body schema: text/plain
required

Body for upserting meshery application source content

string <byte> (source_content)

Source content

Responses

Get design source content

Get application source content

Authorizations:

jwt

path Parameters

id

required

string <uuid> (id)

Unique identifier

Responses

Get application source content

Authorizations:

jwt

path Parameters

id

required

string <uuid> (id)

Unique identifier

Responses

Get application by ID

Authorizations:

jwt

path Parameters

id

required

string <uuid> (id)

Unique identifier

Responses

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"application_file": "string",
"name": "string",
"location": {"property1": "string",
"property2": "string"
},
"visibility": "string",
"source_type": "string",
"source_content": "string",
"catalog_data": {"property1": "string",
"property2": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete application by ID

Delete application associated with ID

Authorizations:

jwt

path Parameters

id

required

string <uuid> (id)

Unique identifier

Responses

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"application_file": "string",
"name": "string",
"location": {"property1": "string",
"property2": "string"
},
"visibility": "string",
"source_type": "string",
"source_content": "string",
"catalog_data": {"property1": "string",
"property2": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Design Share

Share design with others

Authorizations:

jwt

Request Body schema: application/json
required

Body for sharing design

emails required	Array of strings <email> (emails) [ items <email > ]
id required	string <uuid> (id)
content_type	string
share required	boolean

Responses

Request samples

Payload

Content type

application/json

{"emails": ["user@example.com"
],
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"content_type": "string",
"share": true
}

View Share

Share view with others

Authorizations:

jwt

Request Body schema: application/json
required

Body for sharing view

emails required	Array of strings <email> (emails) [ items <email > ]
id required	string <uuid> (id)
content_type required	string
share required	boolean

Responses

Request samples

Payload

Content type

application/json

{"emails": ["user@example.com"
],
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"content_type": "string",
"share": true
}

credentials

APIs for Credentials

Get user's credentials

Get all user's credentials for logged in user

Authorizations:

jwt

query Parameters

page	string Get responses by page
pagesize	string Get responses by pagesize
search	string Get responses that match search param value
order	string Get ordered responses

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"resultType": "string",
"credential": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"name": "string",
"type": "string",
"secret": {"property1": "string",
"property2": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
}
}
]
}

Delete user's credentials

Delete user's credentials (tombstoned records) for logged in user

Authorizations:

jwt

query Parameters

credential_id

required

string

credential Id

Responses

Create Credential

Create new credentials for logged in user

Authorizations:

jwt

Request Body schema: application/json
required

Body for user credential

id

string <uuid> (id)

user_id

string <uuid> (id)

name

string (text)

type

string

object (map_object)

property name*

additional property

string

created_at

string <date-time> (time)

updated_at

string <date-time> (time)

object (nullTime)

time	string <date-time> (time)
valid	boolean

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"name": "string",
"type": "string",
"secret": {"property1": "string",
"property2": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
}
}

Update credential

Update credentials for logged in user

Authorizations:

jwt

Request Body schema: application/json
required

Body for user credential

id

string <uuid> (id)

user_id

string <uuid> (id)

name

string (text)

type

string

object (map_object)

property name*

additional property

string

created_at

string <date-time> (time)

updated_at

string <date-time> (time)

object (nullTime)

time	string <date-time> (time)
valid	boolean

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"name": "string",
"type": "string",
"secret": {"property1": "string",
"property2": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
}
}

environments

Environments are a collection of connections

Create an environment

Creates a new environment

Authorizations:

jwt

Request Body schema: application/json
required

Body for creating environment

name required	string (text) Name
description	string (text) Environment description
OrganizationID	string <uuid> (id) Organization ID

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"OrganizationID": "2d34b1c1-8109-40c1-88f9-fdcfb32ea178"
}

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"environments": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"description": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
}
}
]
}

Get all environments

Gets all environments

Authorizations:

jwt

query Parameters

search	string Get responses that match search param value
order	string Get ordered responses
page	string Get responses by page
pagesize	string Get responses by pagesize
orgID required	string User's organization ID

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"environments": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"description": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
}
}
]
}

Get an environment by ID

Gets an environment by its ID

Authorizations:

jwt

path Parameters

environmentId

required

string <uuid> (id)

Environment ID

query Parameters

orgID

required

string

User's organization ID

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"environments": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"description": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
}
}
]
}

Delete an environment

Deletes an environment by its ID

Authorizations:

jwt

path Parameters

environmentId

required

string <uuid> (id)

Environment ID

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"environments": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"description": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
}
}
]
}

Update an environment

Updates the environment

Authorizations:

jwt

path Parameters

environmentId

required

string <uuid> (id)

Environment ID

Request Body schema: application/json
required

Body for creating environment

name required	string (text) Name
description	string (text) Environment description
OrganizationID	string <uuid> (id) Organization ID

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"OrganizationID": "2d34b1c1-8109-40c1-88f9-fdcfb32ea178"
}

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"environments": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"description": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
}
}
]
}

Get connections of an environment (by default returns assigned)

Gets connections of an environment by its ID

Authorizations:

jwt

path Parameters

environmentId

required

string <uuid> (id)

Environment ID

query Parameters

search	string Get responses that match search param value
order	string Get ordered responses
page	string Get responses by page
pagesize	string Get responses by pagesize
	object Filter for retrieving Environments

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"connections": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"credential_id": "13c40afa-2996-4a0c-b2e9-68fba9462242",
"type": "string",
"sub_type": "string",
"kind": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"status": "discovered",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"environments": {"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"description": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
}
}
}
]
}

Add connection to environment

Adds a connection to an environment by their IDs

Authorizations:

jwt

path Parameters

environmentId required	string <uuid> (id) Environment ID
connectionId required	string <uuid> (id) Connection ID

Responses

Layer5 Cloud production server URL

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

Layer5 Cloud staging server URL

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

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

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

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"resultType": "string",
"environment_connection_mapping": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"environment_id": "40ef0e48-a11f-4963-a229-e396c9f7e7c4",
"connection_id": "d3547de1-d1f2-4344-b4c2-17169b7526f9",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
]
}

Remove connection from environment

Removes a connection from an environment by their IDs

Authorizations:

jwt

path Parameters

environmentId required	string <uuid> (id) Environment ID
connectionId required	string <uuid> (id) Connection ID

Responses

Layer5 Cloud production server URL

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

Layer5 Cloud staging server URL

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

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

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

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"resultType": "string",
"environment_connection_mapping": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"environment_id": "40ef0e48-a11f-4963-a229-e396c9f7e7c4",
"connection_id": "d3547de1-d1f2-4344-b4c2-17169b7526f9",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
]
}

events

Event logs and audit trail

Get Events Aggregate

Get Events Aggreate Count

Authorizations:

jwt

query Parameters

cumulative

string

Cumulative events

Responses

Response samples

200

Content type

application/json

{"audit": 0,
"summary": 0
}

Events by Date

Get Events by date

Authorizations:

jwt

query Parameters

cumulative

string

Cumulative events

Responses

Response samples

200

Content type

application/json

[{"count": 0,
"event_type": "string",
"dt": "2019-08-24T14:15:22Z",
"week": "string",
"month": "string",
"year": "string"
}
]

Events by Week

Get Events by week

Authorizations:

jwt

query Parameters

cumulative

string

Cumulative events

Responses

Response samples

200

Content type

application/json

[{"count": 0,
"event_type": "string",
"dt": "2019-08-24T14:15:22Z",
"week": "string",
"month": "string",
"year": "string"
}
]

Events by Month

Get Events by month

Authorizations:

jwt

query Parameters

cumulative

string

Cumulative events

Responses

Response samples

200

Content type

application/json

[{"count": 0,
"event_type": "string",
"dt": "2019-08-24T14:15:22Z",
"week": "string",
"month": "string",
"year": "string"
}
]

All Events

Get All events

Authorizations:

jwt

query Parameters

page	string Get responses by page
pagesize	string Get responses by pagesize
search	string Get responses that match search param value
order	string Get ordered responses
	object (events_filter) Filter for retrieving events

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"recordType": "string",
"data": [{"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"system_id": "6ed1f7c4-3772-4fa8-92a5-defb7f18dbc4",
"category": "pattern",
"action": "deployed",
"description": "“Prometheus” pattern deployed in K8s ctx “Layer5 Cloud”.",
"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"provider": "string",
"created_at": "2019-08-24T14:15:22Z"
}
]
}

Events Summary

Get Events summary for a user

Authorizations:

jwt

query Parameters

page	string Get responses by page
pagesize	string Get responses by pagesize
search	string Get responses that match search param value
order	string Get ordered responses

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"recordType": "string",
"data": [{"user_id": "string",
"provider": "string",
"email": "string",
"first_name": "string",
"last_name": "string",
"activity_count": 0,
"login_count": 0,
"signup_count": 0,
"perf_results_count": 0,
"smi_results_count": 0,
"meshery_apps_count": 0,
"meshery_patterns_count": 0,
"meshery_filters_count": 0,
"last_login_time": "string"
}
]
}

Event Types

Get Events types

Authorizations:

jwt

Responses

Response samples

200

Content type

application/json

[{"category": "string",
"action": "string"
}
]

github

Add metadata to github connection

Add repo path and installationId as metadata to github connection, and get response of imported designs from passed path

Authorizations:

jwt

Request Body schema: application/json
required

Body for sharing resource

Array of objects (githubRepo)

Array

repoName

string

Relative path of designs of this repo

installationId

string

Installation Id of github connection.

Responses

Request samples

Payload

Content type

application/json

{"path": [{"repoName": "string"
}
],
"installationId": "string"
}

Response samples

200

Content type

application/json

{"repoName": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"user": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "string",
"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"avatar_url": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
},
"pattern_file": "string",
"name": "string",
"location": {"property1": "string",
"property2": "string"
},
"visibility": "string",
"source_type": "string",
"source_content": "string",
"catalog_data": {"property1": "string",
"property2": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Scan and verify if kanvas.yaml file already exist in repository

Scan and verify if kanvas.yaml file already exist in repository by passing repo name and installation id

Authorizations:

jwt

path Parameters

repoName

required

string

The name of the repository

query Parameters

id	string Github installtion id

Responses

Response samples

200

Content type

application/json

{"status": "string",
"error": "string",
"file_url": "string"
}

Scans and returns the paginated tree view of the repository.

Authorizations:

jwt

query Parameters

name	string Example: name=meshery/meshery&name=dapr/helm-charts Repository to scan
page	string Get responses by page

Responses

Response samples

200

Content type

application/json

[{"label": "string",
"type": "string",
"file_info": {"sha": "string",
"path": "string",
"mode": "string",
"type": "string",
"size": "string",
"url": "string"
},
"children": [ ]
}
]

Import designs from github

Authorizations:

jwt

path Parameters

connectionId

required

string <uuid> (id)

Connection ID

Request Body schema: application/json
required

Body for importing designs from github

Array of objects

Array

label	string
type	string Defines whether the current item is a directory or a file.
	object
	Array of objects (repositoryScanResultsPage)

name

string

name of repository.

Responses

Request samples

Payload

Content type

application/json

{"paths": [{"label": "string",
"type": "string",
"file_info": {"sha": "string",
"path": "string",
"mode": "string",
"type": "string",
"size": "string",
"url": "string"
},
"children": [{"label": "string",
"type": "string",
"file_info": {"sha": "string",
"path": "string",
"mode": "string",
"type": "string",
"size": "string",
"url": "string"
},
"children": [ ]
}
]
}
],
"name": "string"
}

Response samples

200

Content type

application/json

{"errors": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"system_id": "6ed1f7c4-3772-4fa8-92a5-defb7f18dbc4",
"operation_id": "cb4ede3c-a5d1-45e3-a9d2-fe83accbce52",
"category": "pattern",
"action": "deployed",
"status": "read",
"acted_upon": "110020-123230-434231-000213",
"description": "“Prometheus” pattern deployed in K8s ctx “Layer5 Cloud”.",
"severity": "info",
"metadata": { },
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
],
"patterns": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"user": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "string",
"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"avatar_url": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
},
"pattern_file": "string",
"name": "string",
"location": {"property1": "string",
"property2": "string"
},
"visibility": "string",
"source_type": "string",
"source_content": "string",
"catalog_data": {"property1": "string",
"property2": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

integrations

APIs for integrations

Register Connection

Register with Layer5 Cloud

Authorizations:

jwt

Request Body schema: application/json
required

Body for registering with Layer5 Cloud

name

string (text)

Name

kind

string (text)

Kind

type

string (text)

Connection type

sub_type

string (text)

Connection subtype

object (map_object)

property name*

additional property

string

object (map_object)

property name*

additional property

string

status

string (text)

Status of the connection

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"kind": "string",
"type": "string",
"sub_type": "string",
"credential_secret": {"property1": "string",
"property2": "string"
},
"metadata": {"property1": "string",
"property2": "string"
},
"status": "string"
}

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"connections": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"credential_id": "13c40afa-2996-4a0c-b2e9-68fba9462242",
"type": "string",
"sub_type": "string",
"kind": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"status": "discovered",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"environments": {"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"description": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
}
}
}
]
}

Get connections

Authorizations:

jwt

query Parameters

page	string Get responses by page
pagesize	string Get responses by pagesize
search	string Get responses that match search param value
order	string Get ordered responses
filter	string Get filtered reponses
kind	Array of arrays Example: kind=meshery&kind=kubernetes Get responses based on connection kind - eg (meshery, kubernetes), kind param can be passed multiple times
status	Array of strings Example: status=connected&status=discovered Get responses based on connection status - eg (connected, discovered), status param can be passed multiple times

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"connections": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"credential_id": "13c40afa-2996-4a0c-b2e9-68fba9462242",
"type": "string",
"sub_type": "string",
"kind": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"status": "discovered",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"environments": {"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"description": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
}
}
}
]
}

Edit Connection by ID

Edit registered connection using the connection ID

Authorizations:

jwt

path Parameters

connectionId

required

string <uuid> (id)

Connection ID

Request Body schema: application/json
required

Body for registering with Layer5 Cloud

name

string (text)

Name

kind

string (text)

Kind

type

string (text)

Connection type

sub_type

string (text)

Connection subtype

object (map_object)

property name*

additional property

string

object (map_object)

property name*

additional property

string

status

string (text)

Status of the connection

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"kind": "string",
"type": "string",
"sub_type": "string",
"credential_secret": {"property1": "string",
"property2": "string"
},
"metadata": {"property1": "string",
"property2": "string"
},
"status": "string"
}

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"connections": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"credential_id": "13c40afa-2996-4a0c-b2e9-68fba9462242",
"type": "string",
"sub_type": "string",
"kind": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"status": "discovered",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"environments": {"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"description": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
}
}
}
]
}

Delete connection

Delete registered connection

Authorizations:

jwt

path Parameters

connectionId

required

string <uuid> (id)

Connection ID

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"connections": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"credential_id": "13c40afa-2996-4a0c-b2e9-68fba9462242",
"type": "string",
"sub_type": "string",
"kind": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"status": "discovered",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"environments": {"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"description": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
}
}
}
]
}

Update Connection Status by ID

Edit connection status using the connection ID

Authorizations:

jwt

path Parameters

connectionId

required

string <uuid> (id)

Connection ID

Request Body schema: text/plain
required

Body containing connection status to update.

string

Responses

Response samples

200
500

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"connections": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"credential_id": "13c40afa-2996-4a0c-b2e9-68fba9462242",
"type": "string",
"sub_type": "string",
"kind": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"status": "discovered",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"environments": {"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"description": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
}
}
}
]
}

Get status of all connections

Get summary about the status of all connections

Authorizations:

jwt

Responses

Response samples

200

Content type

application/json

{"connections_status": [{"status": "string",
"count": 0
}
]
}

Get MeshModel models

query Parameters

page	string Get responses by page
pagesize	string Get responses by pagesize (pass all to get all responses)
search	string Get responses that match search param value
order	string Get ordered responses

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"models": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"version": "string",
"display_name": "string",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"metadata": {"property1": "string",
"property2": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
}
}
]
}

Get MeshModel categories

query Parameters

page	string Get responses by page
pagesize	string Get responses by pagesize
search	string Get responses that match search param value
order	string Get ordered responses

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"categories": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
}
}
]
}

Get connections by kind

path Parameters

connectionKind

required

string

Connection kind (eg: Meshery)

query Parameters

page	string Get responses by page
pagesize	string Get responses by pagesize
search	string Get responses that match search param value
order	string Get ordered responses
mesheryInstanceID	string <uuid> (id) Meshery instance ID

Responses

Response samples

200

Content type

application/json

{ }

Delete connection

Delete registered connection

Authorizations:

jwt

path Parameters

connectionKind

required

string

Connection kind (eg: Meshery)

Responses

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"credential_id": "13c40afa-2996-4a0c-b2e9-68fba9462242",
"type": "string",
"sub_type": "string",
"kind": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"status": "discovered",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"environments": {"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"description": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
}
}
}

Get connections by kind and connectionID.

Get connections by kind (kind is required because this API returns the results in non std format of a connection)

Authorizations:

jwt

path Parameters

connectionKind required	string Connection kind (eg: Meshery)
connectionId required	string <uuid> (id) Connection ID

query Parameters

page	string Get responses by page
pagesize	string Get responses by pagesize
search	string Get responses that match search param value
order	string Get ordered responses

Responses

Layer5 Cloud production server URL

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

Layer5 Cloud staging server URL

https://staging-meshery.layer5.io/api/integrations/connections/{connectionKind}/{connectionId}

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

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

Response samples

200

Content type

application/json

{"k8sContext": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"auth": {"property1": "string",
"property2": "string"
},
"cluster": {"property1": "string",
"property2": "string"
},
"server": "string",
"owner": "534359f7-5407-4b19-ba92-c71c370022a5",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"meshery_instance_id": "bf321bb0-cdd5-4abb-a805-f9cbe16d497d",
"kubernetes_server_id": "80c562e5-e6de-4059-86f9-b4b05f912501",
"deployment_type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"inserted": true
}

Delete Meshery connection

Deletes a given meshery connection. This is generally used for deleting connections from Meshery Server UI where UI is not aware of connection IDs.

Authorizations:

jwt

path Parameters

mesheryServerID

required

string <uuid> (id)

Meshery server ID

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"connections": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"credential_id": "13c40afa-2996-4a0c-b2e9-68fba9462242",
"type": "string",
"sub_type": "string",
"kind": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"status": "discovered",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"environments": {"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"description": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
}
}
}
]
}

keychains

Keychains are collections of keys

Get keychains

Lists the keychains

Authorizations:

jwt

query Parameters

page	string Get responses by page
pagesize	string Get responses by pagesize
search	string Get responses that match search param value
order	string Get ordered responses

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"keys": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"subcategory": "string",
"function": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
},
"category": "string",
"description": "string",
"owner": "534359f7-5407-4b19-ba92-c71c370022a5"
}
]
}

Upsert Keychain

A new keychain is created if id is not provided in the request body. To update an existing keychain pass the updated keychain along with id in request body.

Authorizations:

jwt

Request Body schema: application/json
required

Body for creating keychain

ID

string <uuid> (id)

name

string (text)

owner

string <uuid> (id)

created_at

string <date-time> (time)

updated_at

string <date-time> (time)

object (nullTime)

time	string <date-time> (time)
valid	boolean

Responses

Request samples

Payload

Content type

application/json

{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"owner": "534359f7-5407-4b19-ba92-c71c370022a5",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
}
}

Response samples

200

Content type

application/json

{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"owner": "534359f7-5407-4b19-ba92-c71c370022a5",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
}
}

Get keys of an keychain

Returns all keys belonging to a keychain

Authorizations:

jwt

path Parameters

keychainID

required

string

Keychain Id

query Parameters

page	string Get responses by page
pagesize	string Get responses by pagesize
search	string Get responses that match search param value
order	string Get ordered responses

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"keys": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"subcategory": "string",
"function": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
},
"category": "string",
"description": "string",
"owner": "534359f7-5407-4b19-ba92-c71c370022a5"
}
]
}

Add Key to Keychain

Add a key to a Keychain

Authorizations:

jwt

path Parameters

id required	string <uuid> (id) Unique identifier
keyId required	string <uuid> (id) key ID

Responses

Remove Key from Keychain

Remove a key from Keychain

Authorizations:

jwt

path Parameters

id required	string <uuid> (id) Unique identifier
keyId required	string <uuid> (id) key ID

Responses

Get Key Chain associated with id

Lists the key chain

Authorizations:

jwt

path Parameters

id

required

string <uuid> (id)

Unique identifier

Responses

Response samples

200

Content type

application/json

{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"owner": "534359f7-5407-4b19-ba92-c71c370022a5",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
}
}

Remove Keychain

Deleting a Keychain doesn't delete keys associated with it, instead key chain reference is removed from keys i.e. keys are no longer part of any keychain

Authorizations:

jwt

path Parameters

id

required

string <uuid> (id)

Unique identifier

Responses

keys

Keys represent individual permissions

Get keys

Lists the keys available

Authorizations:

jwt

query Parameters

page	string Get responses by page
pagesize	string Get responses by pagesize
search	string Get responses that match search param value
order	string Get ordered responses

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"keys": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"subcategory": "string",
"function": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
},
"category": "string",
"description": "string",
"owner": "534359f7-5407-4b19-ba92-c71c370022a5"
}
]
}

Upsert key

A new key is created if id is not provided in the request body. To update an existing key pass the updated key along with id in request body.

Authorizations:

jwt

Request Body schema: application/json
required

Body for creating key

ID

string <uuid> (id)

subcategory

string (text)

function

string (text)

created_at

string <date-time> (time)

updated_at

string <date-time> (time)

object (nullTime)

time	string <date-time> (time)
valid	boolean

Responses

Request samples

Payload

Content type

application/json

{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"subcategory": "string",
"function": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
},
"category": "string",
"description": "string",
"owner": "534359f7-5407-4b19-ba92-c71c370022a5"
}

Response samples

200

Content type

application/json

{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"subcategory": "string",
"function": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
},
"category": "string",
"description": "string",
"owner": "534359f7-5407-4b19-ba92-c71c370022a5"
}

Get Key associated with id

Get key by ID

Authorizations:

jwt

path Parameters

id

required

string <uuid> (id)

Unique identifier

Responses

Response samples

200

Content type

application/json

{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"subcategory": "string",
"function": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
},
"category": "string",
"description": "string",
"owner": "534359f7-5407-4b19-ba92-c71c370022a5"
}

Delete key associated with id

Authorizations:

jwt

path Parameters

id

required

string <uuid> (id)

Unique identifier

Responses

organization

Organization Management

Read organizations

Returns all organizations to which the user belongs

Authorizations:

jwt

query Parameters

page	string Get responses by page
pagesize	string Get responses by pagesize
search	string Get responses that match search param value
order	string Get ordered responses
all	boolean Get all possible entries

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"organizations": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"description": "string",
"country": "string",
"region": "string",
"owner": "string",
"metadata": {"preferences": {"theme": {"theme_id": "string",
"logo": {"desktop_view": "string",
"mobile_view": "string"
}
},
"dashboard": {"layout": {"property1": { },
"property2": { }
}
}
}
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
]
}

Create an organization

Creates a new organization

Authorizations:

jwt

Request Body schema: application/json
required

Body for upserting organization

name

string (text)

country

string (text)

region

string (text)

description

string (text)

notify_org_update

boolean

object (organizationPreferences)

object

theme_id	string ID for the theme to load for the currently selected organization
	object

object

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"country": "string",
"region": "string",
"description": "string",
"notify_org_update": true,
"preferences": {"theme": {"theme_id": "string",
"logo": {"desktop_view": "string",
"mobile_view": "string"
}
},
"dashboard": {"layout": {"property1": { },
"property2": { }
}
}
}
}

Response samples

201

Content type

application/json

{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"country": "string",
"region": "string",
"owner": "534359f7-5407-4b19-ba92-c71c370022a5",
"metadata": {"preferences": {"theme": {"theme_id": "string",
"logo": {"desktop_view": "string",
"mobile_view": "string"
}
},
"dashboard": {"layout": {"property1": { },
"property2": { }
}
}
}
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}

Read an organization

Returns the organization

Authorizations:

jwt

path Parameters

orgID

required

string

User's organization ID

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"organizations": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"description": "string",
"country": "string",
"region": "string",
"owner": "string",
"metadata": {"preferences": {"theme": {"theme_id": "string",
"logo": {"desktop_view": "string",
"mobile_view": "string"
}
},
"dashboard": {"layout": {"property1": { },
"property2": { }
}
}
}
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
]
}

Delete an organization

Deletes the organization

Authorizations:

jwt

path Parameters

orgID

required

string

User's organization ID

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"organizations": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"description": "string",
"country": "string",
"region": "string",
"owner": "string",
"metadata": {"preferences": {"theme": {"theme_id": "string",
"logo": {"desktop_view": "string",
"mobile_view": "string"
}
},
"dashboard": {"layout": {"property1": { },
"property2": { }
}
}
}
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
]
}

Update an organization

Updates the organization

Authorizations:

jwt

path Parameters

orgID

required

string

User's organization ID

Request Body schema: application/json
required

Body for upserting organization

name

string (text)

country

string (text)

region

string (text)

description

string (text)

notify_org_update

boolean

object (organizationPreferences)

object

theme_id	string ID for the theme to load for the currently selected organization
	object

object

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"country": "string",
"region": "string",
"description": "string",
"notify_org_update": true,
"preferences": {"theme": {"theme_id": "string",
"logo": {"desktop_view": "string",
"mobile_view": "string"
}
},
"dashboard": {"layout": {"property1": { },
"property2": { }
}
}
}
}

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"organizations": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"description": "string",
"country": "string",
"region": "string",
"owner": "string",
"metadata": {"preferences": {"theme": {"theme_id": "string",
"logo": {"desktop_view": "string",
"mobile_view": "string"
}
},
"dashboard": {"layout": {"property1": { },
"property2": { }
}
}
}
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
]
}

Get preferences for an organization

Get preferences for an organization (theme, custom logos,etc)

Authorizations:

jwt

path Parameters

orgID

required

string

User's organization ID

Responses

Response samples

200

Content type

application/json

{"theme": {"theme_id": "string",
"logo": {"desktop_view": "string",
"mobile_view": "string"
}
},
"dashboard": {"layout": {"property1": { },
"property2": { }
}
}
}

Add team to organization

Authorizations:

jwt

path Parameters

orgID required	string User's organization ID
teamId required	string <uuid> (id) Team's teamId

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"teams_organizations_mapping": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",
"team_id": "810007d0-bec5-486c-b5d1-28fcd8a079ba",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
]
}

Delete team from organization

Authorizations:

jwt

path Parameters

orgID required	string User's organization ID
teamId required	string <uuid> (id) Team's teamId

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"teams_organizations_mapping": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",
"team_id": "810007d0-bec5-486c-b5d1-28fcd8a079ba",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
]
}

Add user to org

Adds the user to the specified org

Authorizations:

jwt

path Parameters

orgID required	string User's organization ID
userId required	string User's user_id

Responses

Delete user from org

Deletes the user from the specified org

Authorizations:

jwt

path Parameters

orgID required	string User's organization ID
userId required	string User's user_id

Responses

performance management

Performance Profiles

Get Performance Profiles for SMP Dashboard

query Parameters

page	string Get responses by page
pagesize	string Get responses by pagesize
search	string Get responses that match search param value
order	string Get ordered responses

Responses

Performance Profiles Results by ID

Get Performance Profiles results by ID for SMP Dashboard

path Parameters

id

required

string <uuid> (id)

Unique identifier

query Parameters

page	string Get responses by page
pagesize	string Get responses by pagesize
search	string Get responses that match search param value
order	string Get ordered responses

Responses

Upsert Performance Profiles

Update performance profiles or create a new performance profile if no id is provided

Authorizations:

jwt

Request Body schema: application/json
required

Body for upserting performance profile

id

string <uuid> (id)

name

string (text)

user_id

string <uuid> (id)

schedule

string <uuid> (id)

load_generators

string

endpoints

string

service_mesh

string

concurrent_request

integer

qps

integer

duration

string

last_run

string <date-time> (time)

total_results

integer

request_headers

string

request_cookies

string

request_body

string

object (map_object)

property name*

additional property

string

created_at

string <date-time> (time)

updated_at

string <date-time> (time)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"schedule": "0caaa334-df8e-492a-85be-f8a502a13416",
"load_generators": "string",
"endpoints": "string",
"service_mesh": "string",
"concurrent_request": 0,
"qps": 0,
"duration": "string",
"last_run": "2019-08-24T14:15:22Z",
"total_results": 0,
"request_headers": "string",
"request_cookies": "string",
"request_body": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Response samples

201

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"schedule": "0caaa334-df8e-492a-85be-f8a502a13416",
"load_generators": "string",
"endpoints": "string",
"service_mesh": "string",
"concurrent_request": 0,
"qps": 0,
"duration": "string",
"last_run": "2019-08-24T14:15:22Z",
"total_results": 0,
"request_headers": "string",
"request_cookies": "string",
"request_body": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Get Performance Profiles

Get performance profiles

Authorizations:

jwt

query Parameters

page	string Get responses by page
pagesize	string Get responses by pagesize
search	string Get responses that match search param value
order	string Get ordered responses

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"resultType": "string",
"profiles": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"schedule": "0caaa334-df8e-492a-85be-f8a502a13416",
"load_generators": "string",
"endpoints": "string",
"service_mesh": "string",
"concurrent_request": 0,
"qps": 0,
"duration": "string",
"last_run": "2019-08-24T14:15:22Z",
"total_results": 0,
"request_headers": "string",
"request_cookies": "string",
"request_body": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Performance Profile by Id

Get Performance Profile by ID

Authorizations:

jwt

path Parameters

id

required

string <uuid> (id)

Unique identifier

Responses

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"schedule": "0caaa334-df8e-492a-85be-f8a502a13416",
"load_generators": "string",
"endpoints": "string",
"service_mesh": "string",
"concurrent_request": 0,
"qps": 0,
"duration": "string",
"last_run": "2019-08-24T14:15:22Z",
"total_results": 0,
"request_headers": "string",
"request_cookies": "string",
"request_body": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete Performance Profiles

Delete performance profiles by ID

Authorizations:

jwt

path Parameters

id

required

string <uuid> (id)

Unique identifier

Responses

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"schedule": "0caaa334-df8e-492a-85be-f8a502a13416",
"load_generators": "string",
"endpoints": "string",
"service_mesh": "string",
"concurrent_request": 0,
"qps": 0,
"duration": "string",
"last_run": "2019-08-24T14:15:22Z",
"total_results": 0,
"request_headers": "string",
"request_cookies": "string",
"request_body": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Performance Profiles result

Get paginated Performance Profiles result

Authorizations:

jwt

path Parameters

id

required

string <uuid> (id)

Unique identifier

query Parameters

page	string Get responses by page
pagesize	string Get responses by pagesize
search	string Get responses that match search param value
order	string Get ordered responses

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"resultType": "string",
"results": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"test_start_time": "2019-08-24T14:15:22Z",
"mesh": "string",
"runner_results": {"property1": "string",
"property2": "string"
},
"deleted": true,
"server_metrics": {"property1": "string",
"property2": "string"
},
"server_board_config": {"property1": "string",
"property2": "string"
},
"performance_profile": "daa36017-1e94-444f-ae03-c54ec0a421d8",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Add performance profiles result

Add performance profile result in given performance profile id

Authorizations:

jwt

path Parameters

id required	string <uuid> (id) Unique identifier
result_id required	string <uuid> (id) Result id

Request Body schema: application/json

Body for adding performance profile result

id

string <uuid> (id)

name

string (text)

test_start_time

string <date-time> (time)

mesh

string

object (map_object)

property name*

additional property

string

deleted

boolean

object (map_object)

property name*

additional property

string

object (map_object)

property name*

additional property

string

performance_profile

string <uuid> (id)

created_at

string <date-time> (time)

updated_at

string <date-time> (time)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"test_start_time": "2019-08-24T14:15:22Z",
"mesh": "string",
"runner_results": {"property1": "string",
"property2": "string"
},
"deleted": true,
"server_metrics": {"property1": "string",
"property2": "string"
},
"server_board_config": {"property1": "string",
"property2": "string"
},
"performance_profile": "daa36017-1e94-444f-ae03-c54ec0a421d8",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Response samples

201

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Performance Profiles result

Get the performance test result associated with the given profile id and with the given test id

Authorizations:

jwt

path Parameters

id required	string <uuid> (id) Unique identifier
result_id required	string <uuid> (id) Result id

Responses

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"test_start_time": "2019-08-24T14:15:22Z",
"mesh": "string",
"runner_results": {"property1": "string",
"property2": "string"
},
"deleted": true,
"server_metrics": {"property1": "string",
"property2": "string"
},
"server_board_config": {"property1": "string",
"property2": "string"
},
"performance_profile": "daa36017-1e94-444f-ae03-c54ec0a421d8",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

performance management results

Performace tests run

Get total performace tests run

Responses

Response samples

200

Content type

application/json

{"total_runs": 0
}

Update SMP results

Update SMP results with metrics

Authorizations:

jwt

Request Body schema: application/json
required

Body for upserting performance result

id

string <uuid> (id)

name

string (text)

test_start_time

string <date-time> (time)

mesh

string

object (map_object)

property name*

additional property

string

deleted

boolean

object (map_object)

property name*

additional property

string

object (map_object)

property name*

additional property

string

performance_profile

string <uuid> (id)

created_at

string <date-time> (time)

updated_at

string <date-time> (time)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"test_start_time": "2019-08-24T14:15:22Z",
"mesh": "string",
"runner_results": {"property1": "string",
"property2": "string"
},
"deleted": true,
"server_metrics": {"property1": "string",
"property2": "string"
},
"server_board_config": {"property1": "string",
"property2": "string"
},
"performance_profile": "daa36017-1e94-444f-ae03-c54ec0a421d8",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Store SMP results

Authorizations:

jwt

Request Body schema: application/json
required

Body for upserting performance result

id

string <uuid> (id)

name

string (text)

test_start_time

string <date-time> (time)

mesh

string

object (map_object)

property name*

additional property

string

deleted

boolean

object (map_object)

property name*

additional property

string

object (map_object)

property name*

additional property

string

performance_profile

string <uuid> (id)

created_at

string <date-time> (time)

updated_at

string <date-time> (time)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"test_start_time": "2019-08-24T14:15:22Z",
"mesh": "string",
"runner_results": {"property1": "string",
"property2": "string"
},
"deleted": true,
"server_metrics": {"property1": "string",
"property2": "string"
},
"server_board_config": {"property1": "string",
"property2": "string"
},
"performance_profile": "daa36017-1e94-444f-ae03-c54ec0a421d8",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Get SMP results

Authorizations:

jwt

query Parameters

page	string Get responses by page
pagesize	string Get responses by pagesize
search	string Get responses that match search param value
order	string Get ordered responses

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"resultType": "string",
"results": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"test_start_time": "2019-08-24T14:15:22Z",
"mesh": "string",
"runner_results": {"property1": "string",
"property2": "string"
},
"deleted": true,
"server_metrics": {"property1": "string",
"property2": "string"
},
"server_board_config": {"property1": "string",
"property2": "string"
},
"performance_profile": "daa36017-1e94-444f-ae03-c54ec0a421d8",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Get SMP result by Id

Get SMP results associated with id

Authorizations:

jwt

path Parameters

id

required

string <uuid> (id)

Unique identifier

Responses

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"test_start_time": "2019-08-24T14:15:22Z",
"mesh": "string",
"runner_results": {"property1": "string",
"property2": "string"
},
"deleted": true,
"server_metrics": {"property1": "string",
"property2": "string"
},
"server_board_config": {"property1": "string",
"property2": "string"
},
"performance_profile": "daa36017-1e94-444f-ae03-c54ec0a421d8",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

plans

User plans

Create a plan

Creates a new plan

Authorizations:

jwt

Request Body schema: application/json
required

Body for upserting plan of kind Meshery with Layer5 Cloud

name	string (planName) Enum: "personal" "team" "enterprise" A list of subscription plans offered for customers
cadence	string (planCadence) Enum: "annually" "monthly" "none"
price	integer <int32> (price)

Responses

Request samples

Payload

Content type

application/json

{"name": "personal",
"cadence": "annually",
"price": 0
}

Response samples

201

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"plans": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "personal",
"cadence": "annually",
"price": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
]
}

Get all plans

Returns all plans for given organization

Authorizations:

jwt

path Parameters

organizationId

required

string

Organization Id

query Parameters

page	string Get responses by page
pagesize	string Get responses by pagesize
search	string Get responses that match search param value
order	string Get ordered responses
filter	string Get filtered reponses

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"plans": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "personal",
"cadence": "annually",
"price": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
]
}

Delete a plan

Deletes the plan with the given ID

Authorizations:

jwt

path Parameters

planId

required

string

Plan Id

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"plans": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "personal",
"cadence": "annually",
"price": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
]
}

Update a plan

Updates the plan with the given ID

Authorizations:

jwt

path Parameters

planId

required

string

Plan Id

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"plans": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "personal",
"cadence": "annually",
"price": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
]
}

resource

Share resource with different actors

Share resource with different actors (actors can be user, team, environment..)

Authorizations:

jwt

path Parameters

resourceType required	string Type of resource e.g design, filter, view, environment, workspace
resourceId required	string <uuid> (id) Id of resource

Request Body schema: application/json
required

Body for sharing resource

Array of objects (actor)

An array containing objects representing actors who will be granted access to the specified resource.

Array

actor_id	string <uuid> (id) UUID of actor
actor_type	string (text) Type of actor, e.g user, team, system.

Array of objects (actor)

An array containing objects representing actors whose access to the specified resource will be revoked.

Array

actor_id	string <uuid> (id) UUID of actor
actor_type	string (text) Type of actor, e.g user, team, system.

notify_users

required

boolean

When set to true, the system will send email notifications to all actors mentioned in the "grant_access" array within the payload.

Responses

Request samples

Payload

Content type

application/json

{"grant_access": [{"actor_id": "04f37679-bfbf-4906-b749-01756515cecf",
"actor_type": "string"
}
],
"revoke_access": [{"actor_id": "04f37679-bfbf-4906-b749-01756515cecf",
"actor_type": "string"
}
],
"notify_users": true
}

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"actor_id": "04f37679-bfbf-4906-b749-01756515cecf",
"action_type": "string",
"resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
"resource_type": "string",
"owner": "534359f7-5407-4b19-ba92-c71c370022a5",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}

Get access record of resource

Get access record of resource by providing resource type and id

Authorizations:

jwt

path Parameters

resourceType required	string Type of resource e.g design, filter, view, environment, workspace
resourceId required	string <uuid> (id) Id of resource

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"actor_id": "04f37679-bfbf-4906-b749-01756515cecf",
"action_type": "string",
"resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
"resource_type": "string",
"owner": "534359f7-5407-4b19-ba92-c71c370022a5",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
]
}

Retrieve all actors that have access for a resource.

Retrieve all actors that have access for a resource, by providing actor type.

Authorizations:

jwt

path Parameters

resourceType required	string Type of resource e.g design, filter, view, environment, workspace
resourceId required	string <uuid> (id) Id of resource
actorType required	string Type of actor e.g user, team, system, registrant

Responses

Layer5 Cloud production server URL

https://meshery.layer5.io/api/resource/{resourceType}/share/{resourceId}/{actorType}

Layer5 Cloud staging server URL

https://staging-meshery.layer5.io/api/resource/{resourceType}/share/{resourceId}/{actorType}

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

http://localhost:9876/api/resource/{resourceType}/share/{resourceId}/{actorType}

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"users": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "string",
"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"avatar_url": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
]
}

rjsf

Get rjsf schema

Authorizations:

jwt

path Parameters

resourceName

required

string

schema Resource Name

Responses

Response samples

200

Content type

application/json

{"rjsfSchema": { },
"uiSchema": { }
}

roles

Roles, assignments to users and assignments of keychains

Assign role Deprecated

Assign role to user

Authorizations:

jwt

Request Body schema: application/json
required

Body for assigning role to the user

role_names required	Array of strings (roleNames)
email required	string <email> (email) email

Responses

Request samples

Payload

Content type

application/json

{"role_names": ["string"
],
"email": "user@example.com"
}

Get All Roles

Get All supported roles

Authorizations:

jwt

path Parameters

orgID

required

string

User's organization ID

query Parameters

page	string Get responses by page
pagesize	string Get responses by pagesize
search	string Get responses that match search param value
order	string Get ordered responses
all	boolean Get all possible entries
selector	string Selector

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"roles": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"role_name": "string",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Upsert roles

A new role is created if id is not provided in the request body. To update an existing role pass the id of the role in request body.

Authorizations:

jwt

path Parameters

orgID

required

string

User's organization ID

Request Body schema: application/json
required

Body for upserting roles

name	string (text)
description	string (text)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string"
}

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"role_name": "string",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]

Bulk Edit Role

Edit roles of user in bulk

Authorizations:

jwt

path Parameters

orgID

required

string

User's organization ID

Request Body schema: application/json
required

Body for editing role of the users in bulk

Array

id

required

string <uuid> (id)

user_id

required

string (user_id)

user's email or username

username

required

string (username)

email

required

string <email> (email)

email

first_name

required

string (text)

First Name

last_name

required

string (text)

Last Name

status

required

string (status)

role_names

required

Array of strings (roleNames)

created_at

required

string <date-time> (time)

updated_at

required

string <date-time> (time)

last_login_time

required

string <date-time> (time)

deleted_at

required

string <date-time> (time)

object (email_preference)

welcome_email	boolean
notify_role_change	boolean

avatar_url

string (avatar_url)

Link for profile picture

object (map_object)

property name*

additional property

string

object (organizationWithRoles)

id	string <uuid> (id)
name	string (text)
description	string (text)
country	string (text)
region	string (text)
owner	string <uuid> (id)
	object (organizationMetadata)
created_at	string <date-time> (time)
updated_at	string <date-time> (time)
deleted_at	string <date-time> (time)
role_names	Array of strings (roleNames)

Array of objects (teamsWithRoles)

Array

id	string <uuid> (id)
name	string (text)
description	string (text)
owner	string <uuid> (id)
created_at	string <date-time> (time)
updated_at	string <date-time> (time)
deleted_at	string <date-time> (time)
role_names	Array of strings (roleNames)

Responses

Request samples

Payload

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "string",
"username": "string",
"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"status": "string",
"role_names": ["string"
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"last_login_time": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"prefs": {"welcome_email": true,
"notify_role_change": true
},
"avatar_url": "string",
"preferences": {"property1": "string",
"property2": "string"
},
"organization_with_roles": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"country": "string",
"region": "string",
"owner": "534359f7-5407-4b19-ba92-c71c370022a5",
"metadata": {"preferences": {"theme": {"theme_id": "string",
"logo": {"desktop_view": "string",
"mobile_view": "string"
}
},
"dashboard": {"layout": {"property1": { },
"property2": { }
}
}
}
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"role_names": ["string"
]
},
"teams_with_roles": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"owner": "534359f7-5407-4b19-ba92-c71c370022a5",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"role_names": ["string"
]
}
]
}
]

Add keychain to roles

Authorizations:

jwt

path Parameters

roleId required	string <uuid> (id) Role's role_id
keychainID required	string Keychain Id
orgID required	string User's organization ID

Responses

Layer5 Cloud production server URL

https://meshery.layer5.io/api/identity/orgs/{orgID}/roles/{roleId}/keychains/{keychainID}

Layer5 Cloud staging server URL

https://staging-meshery.layer5.io/api/identity/orgs/{orgID}/roles/{roleId}/keychains/{keychainID}

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

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

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"keychain_id": "18bca909-53da-4773-8cab-ea019aa83606",
"role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}

Delete keychain from roles

Delete keychain to roles

Authorizations:

jwt

path Parameters

roleId required	string <uuid> (id) Role's role_id
keychainID required	string Keychain Id
orgID required	string User's organization ID

Responses

Layer5 Cloud production server URL

https://meshery.layer5.io/api/identity/orgs/{orgID}/roles/{roleId}/keychains/{keychainID}

Layer5 Cloud staging server URL

https://staging-meshery.layer5.io/api/identity/orgs/{orgID}/roles/{roleId}/keychains/{keychainID}

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

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

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"keychain_id": "18bca909-53da-4773-8cab-ea019aa83606",
"role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}

Get keychain by role ID

GetKeychainByRoleId

Authorizations:

jwt

path Parameters

roleId required	string <uuid> (id) Role's role_id
orgID required	string User's organization ID

query Parameters

page	string Get responses by page
pagesize	string Get responses by pagesize
search	string Get responses that match search param value
order	string Get ordered responses

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"keychains": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"owner": "534359f7-5407-4b19-ba92-c71c370022a5",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
}
}
]
}

Delete Role

Edit roles of user in bulk

Authorizations:

jwt

path Parameters

id

required

string <uuid> (id)

Unique identifier

Responses

Response samples

201

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"role_name": "string",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]

scheduler

APIs for scheduler

Upsert Schedule

It will create a new schedule if not present else it will update the entry matching with the provided id

Authorizations:

jwt

Request Body schema: application/json
required

Body for upserting scheduling

id	string <uuid> (id)
cron_expression	string
user_id	string <uuid> (id)
created_at	string <date-time> (time)
updated_at	string <date-time> (time)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"cron_expression": "string",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Response samples

201

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"cron_expression": "string",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Get schedules

Get paginated schedules

Authorizations:

jwt

query Parameters

page	string Get responses by page
pagesize	string Get responses by pagesize
search	string Get responses that match search param value
order	string Get ordered responses

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"resultType": "string",
"profiles": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"cron_expression": "string",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Get Schedule by Id

Get schedule by Id

Authorizations:

jwt

path Parameters

id

required

string <uuid> (id)

Unique identifier

Responses

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"cron_expression": "string",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete Schedule by ID

Delete schedule by Id

Authorizations:

jwt

path Parameters

id

required

string <uuid> (id)

Unique identifier

Responses

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"cron_expression": "string",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

service mesh interface

APIs for conformance tests

Store SMI result

It will insert the result if not present else it will update the matching entry

Authorizations:

jwt

Request Body schema: application/json
required

Body for upserting SMI result

id

string <uuid> (id)

user_id

string <uuid> (id)

mesh_name

string (text)

mesh_version

string (text)

cases_passed

string (text)

passing_percentage

string (text)

status

string (text)

object (detail)

smi_specification	string (text)
smi_version	string (text)
time	string (text)
assertions	string (text)
result	string (text)
reason	string (text)
capability	string (text)
status	string (text)

test_start_time

string <date-time> (time)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"mesh_name": "string",
"mesh_version": "string",
"cases_passed": "string",
"passing_percentage": "string",
"status": "string",
"more_details": {"smi_specification": "string",
"smi_version": "string",
"time": "string",
"assertions": "string",
"result": "string",
"reason": "string",
"capability": "string",
"status": "string"
},
"test_start_time": "2019-08-24T14:15:22Z"
}

Get SMI Result

Get paginated SMI results

Authorizations:

jwt

query Parameters

page	string Get responses by page
pagesize	string Get responses by pagesize
search	string Get responses that match search param value
order	string Get ordered responses

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"resultType": "string",
"results": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"mesh_name": "string",
"mesh_version": "string",
"cases_passed": "string",
"passing_percentage": "string",
"status": "string",
"more_details": {"smi_specification": "string",
"smi_version": "string",
"time": "string",
"assertions": "string",
"result": "string",
"reason": "string",
"capability": "string",
"status": "string"
},
"test_start_time": "2019-08-24T14:15:22Z"
}
]
}

Get SMI Result by Id

Get SMI Results by Id

Authorizations:

jwt

path Parameters

id

required

string <uuid> (id)

Unique identifier

Responses

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"mesh_name": "string",
"mesh_version": "string",
"cases_passed": "string",
"passing_percentage": "string",
"status": "string",
"more_details": {"smi_specification": "string",
"smi_version": "string",
"time": "string",
"assertions": "string",
"result": "string",
"reason": "string",
"capability": "string",
"status": "string"
},
"test_start_time": "2019-08-24T14:15:22Z"
}

SMI tests run

Get Total SMI test runs

Responses

Response samples

200

Content type

application/json

{"total_runs": 0
}

SMI Public tests

Get SMI Public tests

query Parameters

search	string Get responses that match search param value
order	string Get ordered responses

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"resultType": "string",
"results": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"mesh_name": "string",
"mesh_version": "string",
"cases_passed": "string",
"passing_percentage": "string",
"status": "string",
"more_details": {"smi_specification": "string",
"smi_version": "string",
"time": "string",
"assertions": "string",
"result": "string",
"reason": "string",
"capability": "string",
"status": "string"
},
"test_start_time": "2019-08-24T14:15:22Z"
}
]
}

subscription

Active and inactive subscriptions

Read subscriptions

Returns all subscriptions of a user

Authorizations:

jwt

path Parameters

organizationId

required

string

Organization Id

query Parameters

page	string Get responses by page
pagesize	string Get responses by pagesize
order	string Get ordered responses

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"resultType": "string",
"results": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"org_ID": "9224f810-050a-44ed-9687-77908e626a4d",
"plan_ID": "fe1ec660-d956-4bce-886c-2d466cdbc380",
"subscription_status": "active",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
]
}

Read a subscription

Returns the subscription

Authorizations:

jwt

path Parameters

subscriptionId

required

string

Subscription Id

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"resultType": "string",
"results": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"org_ID": "9224f810-050a-44ed-9687-77908e626a4d",
"plan_ID": "fe1ec660-d956-4bce-886c-2d466cdbc380",
"subscription_status": "active",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
]
}

Delete a subscription

Deletes the subscription

Authorizations:

jwt

path Parameters

subscriptionId

required

string

Subscription Id

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"resultType": "string",
"results": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"org_ID": "9224f810-050a-44ed-9687-77908e626a4d",
"plan_ID": "fe1ec660-d956-4bce-886c-2d466cdbc380",
"subscription_status": "active",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
]
}

Upsert subscription

Upserts a subscription

Authorizations:

jwt

Request Body schema: application/json
required

Subscription to be created

ID	string <uuid> (id)
org_ID	string <uuid> (id)
plan_ID	string <uuid> (id)
subscription_status	string (subscriptionStatus) Enum: "active" "closed" "overdue" "expired" Status of the subscription
start_date	string <date-time> (time)
end_date	string <date-time> (time)
created_at	string <date-time> (time)
updated_at	string <date-time> (time)
deleted_at	string <date-time> (time)

Responses

Request samples

Payload

Content type

application/json

{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"org_ID": "9224f810-050a-44ed-9687-77908e626a4d",
"plan_ID": "fe1ec660-d956-4bce-886c-2d466cdbc380",
"subscription_status": "active",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}

Response samples

201

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"resultType": "string",
"results": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"org_ID": "9224f810-050a-44ed-9687-77908e626a4d",
"plan_ID": "fe1ec660-d956-4bce-886c-2d466cdbc380",
"subscription_status": "active",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
]
}

system

APIs for Meshery system management

Version Info

Meshery Git version and CommitSHA

Responses

Response samples

200

Content type

application/json

{"version": "string",
"commitSHA": "string"
}

teams

User Team Management

Read Team

Returns the specified team

Authorizations:

jwt

path Parameters

teamId required	string <uuid> (id) Team's teamId
orgID required	string User's organization ID

Responses

Response samples

200

Content type

application/json

{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"description": "string",
"owner": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}

Update the specified team

Updates the specified team

Authorizations:

jwt

path Parameters

teamId required	string <uuid> (id) Team's teamId
orgID required	string User's organization ID

Request Body schema: application/json
required

Body for upserting teams

name

string (text)

Team name

description

string (text)

Team description

notify_team_update

boolean

Notify team members about team update

object (map_object)

property name*

additional property

string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"notify_team_update": true,
"metadata": {"property1": "string",
"property2": "string"
}
}

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"teams": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"description": "string",
"owner": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
]
}

Read Teams

Returns all teams belonging to an organization

Authorizations:

jwt

path Parameters

orgID

required

string

User's organization ID

query Parameters

page	string Get responses by page
pagesize	string Get responses by pagesize
search	string Get responses that match search param value
order	string Get ordered responses

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"teams": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"description": "string",
"owner": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
]
}

Create Team

Creates a new Team

Authorizations:

jwt

path Parameters

orgID

required

string

User's organization ID

Request Body schema: application/json
required

Body for upserting teams

name

string (text)

Team name

description

string (text)

Team description

notify_team_update

boolean

Notify team members about team update

object (map_object)

property name*

additional property

string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"notify_team_update": true,
"metadata": {"property1": "string",
"property2": "string"
}
}

Response samples

201

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"teams": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"description": "string",
"owner": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
]
}

List users in Team

Lists the users in the specified team

Authorizations:

jwt

path Parameters

teamId

required

string <uuid> (id)

Team's teamId

query Parameters

page	string Get responses by page
pagesize	string Get responses by pagesize
search	string Get responses that match search param value
order	string Get ordered responses

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"recordType": "string",
"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "string",
"username": "string",
"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"status": "string",
"role_names": ["string"
],
"joined_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"last_login_time": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"prefs": {"welcome_email": true,
"notify_role_change": true
},
"avatar_url": "string"
}
]
}

Add user to team

Adds the user to the specified team

Authorizations:

jwt

path Parameters

teamId required	string <uuid> (id) Team's teamId
userId required	string User's user_id
orgID required	string User's organization ID

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"users_teams_mapping": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"team_id": "810007d0-bec5-486c-b5d1-28fcd8a079ba",
"role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
]
}

Remove user membership from team

Remove the user from the specified team

Authorizations:

jwt

path Parameters

teamId required	string <uuid> (id) Team's teamId
userId required	string User's user_id
orgID required	string User's organization ID

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"users_teams_mapping": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"team_id": "810007d0-bec5-486c-b5d1-28fcd8a079ba",
"role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
]
}

List users not in Team

Lists the users not in the specified team

Authorizations:

jwt

path Parameters

teamId required	string <uuid> (id) Team's teamId
orgID required	string User's organization ID

query Parameters

page	string Get responses by page
pagesize	string Get responses by pagesize
search	string Get responses that match search param value
order	string Get ordered responses

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"recordType": "string",
"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "string",
"username": "string",
"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"status": "string",
"role_names": ["string"
],
"joined_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"last_login_time": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"prefs": {"welcome_email": true,
"notify_role_change": true
},
"avatar_url": "string"
}
]
}

List Team roles

Lists the roles associated with the team

Authorizations:

jwt

path Parameters

teamId

required

string <uuid> (id)

Team's teamId

Responses

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"role_name": "string",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]

Add role to team

Adds role to the specified team

Authorizations:

jwt

path Parameters

teamId required	string <uuid> (id) Team's teamId
roleId required	string <uuid> (id) Role's role_id

Responses

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"role_name": "string",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Remove role from team

Removes role from the specified team

Authorizations:

jwt

path Parameters

teamId required	string <uuid> (id) Team's teamId
roleId required	string <uuid> (id) Role's role_id

Responses

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"role_name": "string",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

tokens

APIs for User tokens

Get Tokens

Get tokens associated with logged in user

Authorizations:

jwt

query Parameters

isOAuth	string To get OAuth tokens as well
page	string Get responses by page
pagesize	string Get responses by pagesize
search	string Get responses that match search param value
order	string Get ordered responses

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"resultType": "string",
"tokens": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"provider": "string",
"access_token": "string",
"refresh_token": "string",
"name": "string",
"purpose": "string",
"is_oauth": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Generate token

Generate token for logged in user

Authorizations:

jwt

query Parameters

name	string Name of the resource
purpose	string Purpose for which token is generated

Responses

Response samples

200

Content type

application/json:

{"page": 0,
"page_size": 0,
"total_count": 0,
"resultType": "string",
"tokens": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"provider": "string",
"access_token": "string",
"refresh_token": "string",
"name": "string",
"purpose": "string",
"is_oauth": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Delete token

Delete token for logged in user

Authorizations:

jwt

query Parameters

token_name required	string (text) Name of the token
token_id required	string <uuid> (id) ID of the token

Request Body schema: application/json
required

Body of type map

property name*

additional property

string

Responses

Request samples

Payload

Content type

application/json

{"property1": "string",
"property2": "string"
}

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"resultType": "string",
"tokens": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"provider": "string",
"access_token": "string",
"refresh_token": "string",
"name": "string",
"purpose": "string",
"is_oauth": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Downloads user token by ID

This API endpoint downloads user token by ID

Authorizations:

jwt

path Parameters

id

required

string <uuid> (id)

Unique identifier

Responses

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"provider": "string",
"access_token": "string",
"refresh_token": "string",
"name": "string",
"purpose": "string",
"is_oauth": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Infinite token

Get Infinite Token

Authorizations:

jwt

query Parameters

user_id required	string UUID of Admin User
provider required	string Remote provider

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"resultType": "string",
"tokens": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"provider": "string",
"access_token": "string",
"refresh_token": "string",
"name": "string",
"purpose": "string",
"is_oauth": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

user onboarding

APIs for user onboarding (signup requests)

Sign up request

Updates user singup request

Authorizations:

jwt

Request Body schema: application/json
required

Body for updating user signup request

id	string <uuid> (id)
first_name	string (text) First Name
last_name	string (text) Last Name
email	string <email> (email) email
occupation	string (text) Occupation
organization	string (text) Organization
role	string (text) Role in organization
form_type	string (text) Form Type (Kanvas or Playground)
status	string (text) Status (approved / denied)
task_id	string (text) ClickUp task id
task_link	string (text) ClickUp task link
created_at	string <date-time> (time)
updated_at	string <date-time> (time)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"occupation": "string",
"organization": "string",
"role": "string",
"form_type": "string",
"status": "string",
"task_id": "string",
"task_link": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Get all Signup requests

Authorizations:

jwt

query Parameters

page	string Get responses by page
pagesize	string Get responses by pagesize
search	string Get responses that match search param value
order	string Get ordered responses
	object Filter for catalog requests

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"resultType": "string",
"signup_data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"occupation": "string",
"organization": "string",
"role": "string",
"form_type": "string",
"status": "string",
"task_id": "string",
"task_link": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Approve Signup request

Authorizations:

jwt

query Parameters

id	string <uuid> (id) Signup request id
first_name	string First Name
last_name	string Last Name
email	string Email
occupation	string <email> (email) Email
organization	string Organization
role	string Role in organization
form_type	string Form Type (Kanvas or Playground)
status	string Status (approved / denied)
task_id	string Click up task id
task_link	string Click up task link

Responses

Deny signup request

Deny Signup Request

Authorizations:

jwt

query Parameters

id	string <uuid> (id) Signup request id
first_name	string First Name
last_name	string Last Name
email	string Email
occupation	string <email> (email) Email
organization	string Organization
role	string Role in organization
form_type	string Form Type (Kanvas or Playground)
status	string Status (approved / denied)
task_id	string Click up task id
task_link	string Click up task link

Responses

Approve signup request by ID

Approve signup request associated with ID

Authorizations:

jwt

path Parameters

id

required

string <uuid> (id)

Unique identifier

Responses

Deny signup request by ID

Deny signup request associated with ID

Authorizations:

jwt

path Parameters

id

required

string <uuid> (id)

Unique identifier

Responses

Signup request notification

Authorizations:

jwt

Responses

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"occupation": "string",
"organization": "string",
"role": "string",
"form_type": "string",
"status": "string",
"task_id": "string",
"task_link": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

users

User Management

User Invite

Send invitation request to users

Authorizations:

jwt

path Parameters

orgID

required

string

User's organization ID

Request Body schema: application/json
required

Body for user invite request

first_name

required

string (text)

First Name

last_name

required

string (text)

Last Name

email

required

string <email> (email)

email

Array of objects (team)

Array

ID	string <uuid> (id) Team ID
name	string (text) Team name
description	string (text) Team description
owner	string <uuid> (id) Team owner
created_at	string <date-time> (time)
updated_at	string <date-time> (time)
deleted_at	string <date-time> (time)

team_roles

Array of strings (text)

Team level roles (team admin)

org_roles

Array of strings (text)

Organization level roles (organization admin)

roles

Array of strings (text)

Provider level roles (kanvas, admin, curator)

Responses

Request samples

Payload

Content type

application/json

{"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"teams": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"description": "string",
"owner": "534359f7-5407-4b19-ba92-c71c370022a5",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
],
"team_roles": ["string"
],
"org_roles": ["string"
],
"roles": ["string"
]
}

User Preference

Upsert user preferences

Authorizations:

jwt

Request Body schema: application/json
required

Body for upserting user preferences

property name*

additional property

string

Responses

Request samples

Payload

Content type

application/json

{"property1": "string",
"property2": "string"
}

Get User Keys

Get all keys based on roles assigned to user

Authorizations:

jwt

path Parameters

orgID

required

string

User's organization ID

Responses

Response samples

200

Content type

application/json

{"keys": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"subcategory": "string",
"function": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
},
"category": "string",
"description": "string",
"owner": "534359f7-5407-4b19-ba92-c71c370022a5"
}
],
"total_count": 0
}

Delete users

Delete own account. Any user can perform this action.

Authorizations:

jwt

Responses

Get User by ID

Get specific user by user_id

Authorizations:

jwt

path Parameters

userId

required

string

User's user_id

Responses

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "string",
"provider": "string",
"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"avatar_url": "string",
"status": "string",
"bio": "string",
"preferences": {"property1": "string",
"property2": "string"
},
"accepted_terms_at": "string",
"first_login_time": "2019-08-24T14:15:22Z",
"last_login_time": "2019-08-24T14:15:22Z",
"role_names": ["string"
],
"teams": {"total_count": 0,
"teams_with_roles": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"description": "string",
"owner": "534359f7-5407-4b19-ba92-c71c370022a5",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
]
}
}

Delete users

Delete users account based on user_id. For Provider Admin use case only.

Authorizations:

jwt

path Parameters

userId

required

string

User's user_id

Responses

Bulk Delete users

Bulk delete users account based on user_id for a give org. For Provider Admin use case only.

Authorizations:

jwt

path Parameters

orgID

required

string

User's organization ID

Request Body schema: application/json
required

Body for delete of user accounts

One of

user_ids required	string <uuid> (id)
user_emails required	Array of strings <email> (emails) [ items <email > ]

Responses

Request samples

Payload

Content type

application/json

Example

bulkDelete

{"user_ids": "2d98503d-4ab4-41bd-8fc6-78cc006fd2db",
"user_emails": ["user@example.com"
]
}

Get All users for a given org

Authorizations:

jwt

path Parameters

orgID

required

string

User's organization ID

query Parameters

page	string Get responses by page
pagesize	string Get responses by pagesize
search	string Get responses that match search param value
order	string Get ordered responses
filter	string Get filtered reponses
teamID	string <uuid> (id) Team's teamId

Responses

Response samples

200

Content type

application/json

Example

usersPageForAdmin

{"page": 0,
"page_size": 0,
"total_count": 0,
"recordType": "string",
"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "string",
"username": "string",
"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"status": "string",
"role_names": ["string"
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"last_login_time": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"prefs": {"welcome_email": true,
"notify_role_change": true
},
"avatar_url": "string",
"preferences": {"property1": "string",
"property2": "string"
},
"organization_with_roles": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"country": "string",
"region": "string",
"owner": "534359f7-5407-4b19-ba92-c71c370022a5",
"metadata": {"preferences": {"theme": {"theme_id": "string",
"logo": {"desktop_view": "string",
"mobile_view": "string"
}
},
"dashboard": {"layout": {"property1": { },
"property2": { }
}
}
}
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"role_names": ["string"
]
},
"teams_with_roles": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"owner": "534359f7-5407-4b19-ba92-c71c370022a5",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"role_names": ["string"
]
}
]
}
]
}

Get All users (for public view)

Get All users

Authorizations:

jwt

query Parameters

page	string Get responses by page
pagesize	string Get responses by pagesize
search	string Get responses that match search param value
order	string Get ordered responses
filter	string Get filtered reponses

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"recordType": "string",
"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "string",
"username": "string",
"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"prefs": {"welcome_email": true,
"notify_role_change": true
},
"avatar_url": "string",
"preferences": {"property1": "string",
"property2": "string"
}
}
]
}

Get user profile by Id

Get user profile of given user Id

Authorizations:

jwt

path Parameters

id

required

string <uuid> (id)

Unique identifier

Responses

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "string",
"provider": "string",
"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"avatar_url": "string",
"status": "string",
"bio": "string",
"preferences": {"property1": "string",
"property2": "string"
},
"accepted_terms_at": "string",
"first_login_time": "2019-08-24T14:15:22Z",
"last_login_time": "2019-08-24T14:15:22Z",
"role_names": ["string"
],
"teams": {"total_count": 0,
"teams_with_roles": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"description": "string",
"owner": "534359f7-5407-4b19-ba92-c71c370022a5",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
]
}
}

Get User details

Get user details for logged in user

Authorizations:

jwt

Responses

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "string",
"provider": "string",
"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"avatar_url": "string",
"status": "string",
"bio": "string",
"preferences": {"property1": "string",
"property2": "string"
},
"accepted_terms_at": "string",
"first_login_time": "2019-08-24T14:15:22Z",
"last_login_time": "2019-08-24T14:15:22Z",
"role_names": ["string"
],
"teams": {"total_count": 0,
"teams_with_roles": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"description": "string",
"owner": "534359f7-5407-4b19-ba92-c71c370022a5",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
]
}
}

Update Profile

Update user profile data (also updates kratos identity)

Authorizations:

jwt

Request Body schema: application/json
required

Body for upserting user

id

required

string <uuid> (id)

user_id

required

string (user_id)

user's email or username

provider

required

string (provider)

One of (meshery-cloud, github, google)

email

required

string <email> (email)

email

first_name

required

string (text)

First Name

last_name

required

string (text)

Last Name

avatar_url

string (avatar_url)

Link for profile picture

status

required

string (status)

bio

string (bio)

object (map_object)

property name*

additional property

string

accepted_terms_at

string (accepted_terms_at)

first_login_time

string <date-time> (time)

last_login_time

required

string <date-time> (time)

role_names

Array of strings (roleNames)

object

total_count

integer

Array of objects (teams)

Array

ID	string <uuid> (id) Team ID
name	string (text) Team name
description	string (text) Team description
owner	string <uuid> (id) Team owner
created_at	string <date-time> (time)
updated_at	string <date-time> (time)
deleted_at	string <date-time> (time)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "string",
"provider": "string",
"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"avatar_url": "string",
"status": "string",
"bio": "string",
"preferences": {"property1": "string",
"property2": "string"
},
"accepted_terms_at": "string",
"first_login_time": "2019-08-24T14:15:22Z",
"last_login_time": "2019-08-24T14:15:22Z",
"role_names": ["string"
],
"teams": {"total_count": 0,
"teams_with_roles": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"description": "string",
"owner": "534359f7-5407-4b19-ba92-c71c370022a5",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
]
}
}

Profile Overview

Get Profile overview for logged in user

Authorizations:

jwt

Responses

Response samples

200

Content type

application/json

{"k8s_count": 0,
"app_count": 0,
"pattern_count": 0
}

User Activity

Get user's most recent activity

path Parameters

user_id

required

string

UUID of User

query Parameters

page	string Get responses by page
pagesize	string Get responses by pagesize
order	string Get ordered responses
filter	string Get filtered reponses

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"activities": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"system_id": "6ed1f7c4-3772-4fa8-92a5-defb7f18dbc4",
"operation_id": "cb4ede3c-a5d1-45e3-a9d2-fe83accbce52",
"category": "pattern",
"action": "deployed",
"status": "read",
"acted_upon": "110020-123230-434231-000213",
"description": "“Prometheus” pattern deployed in K8s ctx “Layer5 Cloud”.",
"severity": "info",
"metadata": { },
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
]
}

Online users

Get info of active / online users in last 24 hours

Authorizations:

jwt

Responses

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"first_name": "string",
"last_name": "string",
"avatar_url": "string"
}
]

Send comment email notification to users

Send email notification to mentioned users, thread participants or owner about comment.

Authorizations:

jwt

Request Body schema: application/json
required

Body for sending email notifications about comments

mention_users

Array of strings <uuid> (user_ids) [ items <uuid > ]

participants

Array of strings <uuid> (user_ids) [ items <uuid > ]

users_opted_out_of_notifications

Array of strings <uuid> (user_ids) [ items <uuid > ]

design_id

required

string <uuid> (id)

Array of objects (commentMessage)

Array

firstName required	string (text)
lastName required	string (text)
avatarURL required	string (text)
userId required	string <uuid> (id)
timestamp required	string <date-time> (time)

Responses

Request samples

Payload

Content type

application/json

{"mention_users": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"participants": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"users_opted_out_of_notifications": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"design_id": "3c3997d4-c335-47fb-9214-209c16a24ffd",
"messages": [{"firstName": "string",
"lastName": "string",
"avatarURL": "string",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"timestamp": "2019-08-24T14:15:22Z"
}
]
}

Send feedback email notification to user and cloud provider admins

Send email notification to user who filled the feedback, and to all provider admins.

Authorizations:

jwt

Request Body schema: application/json
required

Body for sending feedback email notifications

message

required

string (text)

Feedback message.

scope

required

string (text)

Scope of the feedback. The client can provide any scope, such as (Idea, Issue, Other).

page_location

required

string (text)

The route URL of the page from which the user submitted the feedback.

object (map_object)

Additional information that the email should contain for better review. This field accepts an object; make sure the keys are in Sentence case, e.g., ('Design link': 'page link').

property name*

additional property

string

Responses

Request samples

Payload

Content type

application/json

{"message": "string",
"scope": "string",
"page_location": "string",
"metadata": {"property1": "string",
"property2": "string"
}
}

Get recently online users for org

Get info of active / online users for an org in last 24 hours

Authorizations:

jwt

path Parameters

orgID

required

string

User's organization ID

Responses

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"first_name": "string",
"last_name": "string",
"avatar_url": "string"
}
]

Gets available badges

Authorizations:

jwt

Responses

Response samples

200

Content type

application/json

{"badges": {"property1": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"label": "string",
"svg_location": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
}
},
"property2": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"label": "string",
"svg_location": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
}
}
},
"total_count": 0
}

Assign a badge to user

Authorizations:

jwt

Request Body schema: application/json
required

Body for un/assigning badges

user_id	string <uuid> (id)
badges	Array of strings (text)

Responses

Request samples

Payload

Content type

application/json

{"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"badges": ["string"
]
}

UnAssign a badge to user

Assign a badge to user

Authorizations:

jwt

Request Body schema: application/json
required

Body for un/assigning badges

user_id	string <uuid> (id)
badges	Array of strings (text)

Responses

Request samples

Payload

Content type

application/json

{"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"badges": ["string"
]
}

Get user provider

Authorizations:

jwt

Responses

Response samples

200

Content type

application/json

{"provider": "github"
}

Update user password

Authorizations:

jwt

Request Body schema: application/json
required

Body for new password

password

string

password

Responses

Request samples

Payload

Content type

application/json

{"password": "this is test password"
}

Updates the notification preferences of the user

Authorizations:

jwt

Request Body schema: application/json
required

Body for updating notification preferences

notificationPreferences required	Array of strings (text)
user_id required	string (text)

Responses

Request samples

Payload

Content type

application/json

{"notificationPreferences": ["string"
],
"user_id": "string"
}

Get available notification preferences

Authorizations:

jwt

Responses

Response samples

200

Content type

application/json

{"notificationsPreferences": {"property1": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"category": "string",
"subcategory": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
}
},
"property2": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"category": "string",
"subcategory": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
}
}
},
"total_count": 0
}

views

Get a view by ID

Gets a view by its ID

Authorizations:

jwt

path Parameters

viewId

required

string <uuid> (id)

View ID

Responses

Response samples

200

Content type

application/json

{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"filters": {"property1": "string",
"property2": "string"
},
"visibility": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"user_id": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
}
}

Delete a view

Deletes a view by its ID

Authorizations:

jwt

path Parameters

viewId

required

string <uuid> (id)

View ID

Responses

Response samples

200

Content type

application/json

{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"filters": {"property1": "string",
"property2": "string"
},
"visibility": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"user_id": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
}
}

Update a view

Updates the view

Authorizations:

jwt

path Parameters

viewId

required

string <uuid> (id)

View ID

Request Body schema: application/json
required

Body for updating view

name

string (text)

Name of view

object (map_object)

View's Filter

property name*

additional property

string

object (map_object)

View's Metadata

property name*

additional property

string

visibility

string (text)

View visibility (it should be only 'private' or 'public')

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"filters": {"property1": "string",
"property2": "string"
},
"metadata": {"property1": "string",
"property2": "string"
},
"visibility": "string"
}

Response samples

200

Content type

application/json

{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"filters": {"property1": "string",
"property2": "string"
},
"visibility": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"user_id": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
}
}

Create a view

Creates a new view

Authorizations:

jwt

Request Body schema: application/json
required

Body for creating view

name

required

string (text)

Name of meshery view

object (map_object)

View's Filter

property name*

additional property

string

object (map_object)

View's Metadata

property name*

additional property

string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"filters": {"property1": "string",
"property2": "string"
},
"metadata": {"property1": "string",
"property2": "string"
}
}

Response samples

201

Content type

application/json

{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"filters": {"property1": "string",
"property2": "string"
},
"visibility": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"user_id": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
}
}

Get all views

Gets all views

Authorizations:

jwt

query Parameters

search	string Get responses that match search param value
order	string Get ordered responses
page	string Get responses by page
pagesize	string Get responses by pagesize
filter	string Get filtered reponses
visibility	string Get responses based on visibility - private, public or published
user_id	string UUID of User. Pass user_id for fetching public and private views of a user

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"views": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"filters": {"property1": "string",
"property2": "string"
},
"visibility": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"user_id": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
}
}
]
}

webhook

Call webhook from server

This API calls defined webhooks from server, supported types are (support, kanvasEntitlement).

Authorizations:

jwt

path Parameters

webhookType

required

string

Webhook type support from server like (support, kanvasEntitlement)

Request Body schema: application/json
required

property name*

additional property

any

Responses

Request samples

Payload

Content type

application/json

{ }

workspaces

Workspaces bring teams, environments, and designs together

Create an workspace

Creates a new workspace

Authorizations:

jwt

path Parameters

orgID

required

string

User's organization ID

Request Body schema: application/json
required

Body for creating workspace

name

required

string (text)

Name

description

string (text)

Workspace description

organization_id

required

string <uuid> (id)

Organization ID

object (map_object)

Metadata related to workspace

property name*

additional property

string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"metadata": {"property1": "string",
"property2": "string"
}
}

Response samples

201

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"environments": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"description": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner": "534359f7-5407-4b19-ba92-c71c370022a5",
"metadata": {"property1": "string",
"property2": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
}
}
]
}

Get all workspaces

Gets all workspaces

Authorizations:

jwt

query Parameters

search	string Get responses that match search param value
order	string Get ordered responses
page	string Get responses by page
pagesize	string Get responses by pagesize
filter	string Get filtered reponses
orgID required	string User's organization ID

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"environments": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"description": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner": "534359f7-5407-4b19-ba92-c71c370022a5",
"metadata": {"property1": "string",
"property2": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
}
}
]
}

Get an workspace by ID

Gets an workspace by its ID

Authorizations:

jwt

path Parameters

workspaceId

required

string <uuid> (id)

Workspace ID

query Parameters

orgID

required

string

User's organization ID

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"environments": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"description": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner": "534359f7-5407-4b19-ba92-c71c370022a5",
"metadata": {"property1": "string",
"property2": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
}
}
]
}

Delete an workspace

Deletes an workspace by its ID

Authorizations:

jwt

path Parameters

workspaceId

required

string <uuid> (id)

Workspace ID

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"environments": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"description": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner": "534359f7-5407-4b19-ba92-c71c370022a5",
"metadata": {"property1": "string",
"property2": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
}
}
]
}

Update an workspace

Updates the workspace

Authorizations:

jwt

path Parameters

workspaceId

required

string <uuid> (id)

Workspace ID

Request Body schema: application/json
required

Body for updating workspace

name	string (text) Name of workspace
description	string (text) Environment description
organization_id required	string <uuid> (id) Organization ID

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"environments": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"description": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner": "534359f7-5407-4b19-ba92-c71c370022a5",
"metadata": {"property1": "string",
"property2": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
}
}
]
}

Get all teams assigned to a workspace (by default returns assigned)

Gets an Teams of a given workspace by its ID

Authorizations:

jwt

path Parameters

workspaceId

required

string <uuid> (id)

Workspace ID

query Parameters

search	string Get responses that match search param value
order	string Get ordered responses
page	string Get responses by page
pagesize	string Get responses by pagesize
	object Filter for retrieving Workspaces

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"teams": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"description": "string",
"owner": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
]
}

Unassign a team from a workspace

Unassigns a team from a workspace

Authorizations:

jwt

path Parameters

workspaceId required	string <uuid> (id) Workspace ID
teamId required	string <uuid> (id) Team's teamId

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"resultType": "string",
"workspaces_teams_mapping": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"team_id": "810007d0-bec5-486c-b5d1-28fcd8a079ba",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
]
}

Assign a team to a workspace

Assigns a team to a workspace

Authorizations:

jwt

path Parameters

workspaceId required	string <uuid> (id) Workspace ID
teamId required	string <uuid> (id) Team's teamId

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"resultType": "string",
"workspaces_teams_mapping": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"team_id": "810007d0-bec5-486c-b5d1-28fcd8a079ba",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
]
}

Get all environments assigned to a workspace (by default returns assigned)

Gets an environments of a given workspace by its ID

Authorizations:

jwt

path Parameters

workspaceId

required

string <uuid> (id)

Workspace ID

query Parameters

search	string Get responses that match search param value
order	string Get ordered responses
page	string Get responses by page
pagesize	string Get responses by pagesize
	object Filter for retrieving Workspaces

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"environments": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"description": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
}
}
]
}

Unassign a environment from a workspace

Unassigns a environment from a workspace

Authorizations:

jwt

path Parameters

workspaceId required	string <uuid> (id) Workspace ID
environmentId required	string <uuid> (id) Environment ID

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"resultType": "string",
"workspaces_environments_mapping": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"environment_id": "40ef0e48-a11f-4963-a229-e396c9f7e7c4",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
]
}

Assign a environment to a workspace

Assigns a environment to a workspace

Authorizations:

jwt

path Parameters

workspaceId required	string <uuid> (id) Workspace ID
environmentId required	string <uuid> (id) Environment ID

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"resultType": "string",
"workspaces_environments_mapping": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"environment_id": "40ef0e48-a11f-4963-a229-e396c9f7e7c4",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
]
}

Unassign a design from a workspace

Authorizations:

jwt

path Parameters

workspaceId required	string <uuid> (id) Workspace ID
designId required	string <uuid> (id) Design ID

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"resultType": "string",
"workspaces_designs_mapping": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"design_id": "3c3997d4-c335-47fb-9214-209c16a24ffd",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
]
}

Assign a design to a workspace

Assigns a design to a workspace

Authorizations:

jwt

path Parameters

workspaceId required	string <uuid> (id) Workspace ID
designId required	string <uuid> (id) Design ID

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"resultType": "string",
"workspaces_designs_mapping": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"design_id": "3c3997d4-c335-47fb-9214-209c16a24ffd",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
]
}

Get all designs assigned to a workspace (by default returns assigned)

Gets an designs of a given workspace by its ID

Authorizations:

jwt

path Parameters

workspaceId

required

string <uuid> (id)

Workspace ID

query Parameters

search	string Get responses that match search param value
order	string Get ordered responses
page	string Get responses by page
pagesize	string Get responses by pagesize
	object Filter for retrieving Workspaces

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"resultType": "string",
"designs": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"user": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "string",
"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"avatar_url": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
},
"pattern_file": "string",
"name": "string",
"location": {"property1": "string",
"property2": "string"
},
"visibility": "string",
"source_type": "string",
"source_content": "string",
"catalog_data": {"property1": "string",
"property2": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Unassign a view from a workspace

Authorizations:

jwt

path Parameters

workspaceId required	string <uuid> (id) Workspace ID
viewId required	string <uuid> (id) View ID

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"resultType": "string",
"workspaces_views_mapping": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"view_id": "51ee3349-7269-4d2c-8a79-ea7055ee54f4",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
]
}

Assign a view to a workspace

Assigns a view to a workspace

Authorizations:

jwt

path Parameters

workspaceId required	string <uuid> (id) Workspace ID
viewId required	string <uuid> (id) View ID

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"resultType": "string",
"workspaces_views_mapping": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"view_id": "51ee3349-7269-4d2c-8a79-ea7055ee54f4",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
]
}

Get all views assigned to a workspace (by default returns assigned)

Gets views of a given workspace by its ID

Authorizations:

jwt

path Parameters

workspaceId

required

string <uuid> (id)

Workspace ID

query Parameters

search	string Get responses that match search param value
order	string Get ordered responses
page	string Get responses by page
pagesize	string Get responses by pagesize
	object Filter for retrieving Workspaces

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"views": [{"ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
"name": "string",
"filters": {"property1": "string",
"property2": "string"
},
"visibility": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"user_id": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": {"time": "2019-08-24T14:15:22Z",
"valid": true
}
}
]
}

Get all events of workspace

Get all events of workspace. Only users that have access to a workspace can get its events. Provider Admins can see events for any workspace

Authorizations:

jwt

path Parameters

workspaceId

required

string <uuid> (id)

Workspace ID

query Parameters

page	string Get responses by page
pagesize	string Get responses by pagesize
search	string Get responses that match search param value
order	string Get ordered responses

Responses

Response samples

200

Content type

application/json

{"page": 0,
"page_size": 0,
"total_count": 0,
"recordType": "string",
"data": [{"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"system_id": "6ed1f7c4-3772-4fa8-92a5-defb7f18dbc4",
"category": "pattern",
"action": "deployed",
"description": "“Prometheus” pattern deployed in K8s ctx “Layer5 Cloud”.",
"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"provider": "string",
"created_at": "2019-08-24T14:15:22Z"
}
]
}

Layer5 Cloud (v0.8.42)

capabilities

Capabilities Deprecated

query Parameters

Responses

Response samples

Capabilities By server version

path Parameters

query Parameters

Responses

Response samples

catalog

Get Catalog Content

path Parameters

query Parameters

Responses

Response samples

Publish Catalog Content

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Unpublish Catalog Content

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Approve Catalog Request

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Get supported catalog classes

Authorizations:

Responses

Response samples

Deny Catalog Request

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Catalog Request

Authorizations:

query Parameters

Responses

Response samples

collaboration

Collaboration

Authorizations:

Responses

content

Upsert Pattern resource

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get Pattern resources

Authorizations:

query Parameters

Responses

Response samples

Pattern Resource by ID

Authorizations:

path Parameters

Responses

Response samples

Delete pattern resource

Authorizations:

path Parameters

Responses

Response samples

Upsert pattern source content

Authorizations:

path Parameters

Request Body schema: text/plainrequired

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: text/plain
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required