Update a Key Set in a workspace

Update a Key Set in a workspace

patch
{protocol}://{hostname}:{port}{path}/{workspace}/key-sets/{key-set_id_or_name}

Path Parameters

workspacestringrequired

Name or ID of workspace

Example:team-a

key-set_id_or_namestringrequired

The unique identifier or the name attribute of the Key Set that should be associated to the newly-created Key.

Example:46CA83EE-671C-11ED-BFAB-2FE47512C77A

Body

application/json

The request body for creating a new Key Set entity.

namestring

The name to associate with the given Key Set.

Example:my-key_set

tagsarray[string]

An optional set of strings associated with the Key for grouping and filtering.

Response

application/json

Key set object response body

idstring

Example:4D0DBDA-671C-11ED-BA0B-EF1DCCD3725F

namestring

The name to associate with the given Key Set.

Example:my-key_set

created_atinteger

Unix epoch when the resource was last created.

Example:1422386534

updated_atinteger

Unix epoch when the resource was last updated.

Example:1422386534

tagsarray[string]

The name to associate with the given Key Set

nextstring

Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page

Example:http://localhost:8001/key-sets?offset=6378122c-a0a1-438d-a5c6-efabae9fb969

patch/{workspace}/key-sets/{key-set_id_or_name}

Body

{
"name": "my-key_set",
"tags": [
"[]"
]
}
 
application/json

Upsert a Key Set in a workspace

Create or Update Key Set using ID or name in a workspace.

put
{protocol}://{hostname}:{port}{path}/{workspace}/key-sets/{key-set_id_or_name}

Path Parameters

workspacestringrequired

Name or ID of workspace

Example:team-a

key-set_id_or_namestringrequired

The unique identifier or the name attribute of the Key Set that should be associated to the newly-created Key.

Example:46CA83EE-671C-11ED-BFAB-2FE47512C77A

Body

application/json

The request body for creating a new Key Set entity.

namestring

The name to associate with the given Key Set.

Example:my-key_set

tagsarray[string]

An optional set of strings associated with the Key for grouping and filtering.

Response

application/json

Key set object response body

idstring

Example:4D0DBDA-671C-11ED-BA0B-EF1DCCD3725F

namestring

The name to associate with the given Key Set.

Example:my-key_set

created_atinteger

Unix epoch when the resource was last created.

Example:1422386534

updated_atinteger

Unix epoch when the resource was last updated.

Example:1422386534

tagsarray[string]

The name to associate with the given Key Set

nextstring

Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page

Example:http://localhost:8001/key-sets?offset=6378122c-a0a1-438d-a5c6-efabae9fb969

put/{workspace}/key-sets/{key-set_id_or_name}

Body

{
"name": "my-key_set",
"tags": [
"[]"
]
}
 
application/json

List all Workspaces

List all Workspaces

For workspace use cases and configuration examples, see Workspace examples. This endpoint will only return workspaces that the current user has access to.

get
{protocol}://{hostname}:{port}{path}/workspaces

Query Parameters

sizeinteger

Number of resources to be returned.

Default:100

>= 1<= 1000

offsetstring

Offset from which to return the next set of resources. Use the value of the ‘offset’ field from the response of a list operation as input here to paginate through all the resources

tagsstring

Example:tag1,tag2

Response

application/json

A successful response listing Workspaces

dataarray[object]

Workspaces provide a way to segment Kong entities.

Show Child Parameters
offsetstring

Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page

get/workspaces
 
application/json

Create a new Workspace

Create a new Workspace

For workspace use cases and configuration examples, see Workspace examples.

post
{protocol}://{hostname}:{port}{path}/workspaces

Body

application/json

Description of the new Workspace for creation

Workspace

Workspaces provide a way to segment Kong entities.

commentstring
configobject
Show Child Parameters
created_atinteger

Unix epoch when the resource was created.

idstring

The unique UUID for this resource.

metaobject
Show Child Parameters
namestring

Response

application/json

Successfully created Workspace

Workspace

Workspaces provide a way to segment Kong entities.

commentstring
configobject
Show Child Parameters
created_atinteger

Unix epoch when the resource was created.

idstring

The unique UUID for this resource.

metaobject
Show Child Parameters
namestring
post/workspaces

Body

{
"comment": "comment",
"config": {
"meta": {},
"portal": false,
"portal_access_request_email": false,
"portal_application_request_email": false,
"portal_application_status_email": false,
"portal_approved_email": false,
"portal_auth": "portal_auth",
"portal_auth_conf": "portal_auth_conf",
"portal_auto_approve": false,
"portal_cors_origins": [
"[]"
],
"portal_developer_meta_fields": "[{\"label\":\"Full Name\",\"title\":\"full_name\",\"validator\":{\"required\":true,\"type\":\"string\"}}]",
"portal_emails_from": "portal_emails_from",
"portal_emails_reply_to": "portal_emails_reply_to",
"portal_invite_email": false,
"portal_is_legacy": false,
"portal_reset_email": false,
"portal_reset_success_email": false,
"portal_session_conf": "portal_session_conf",
"portal_smtp_admin_emails": [
"[]"
],
"portal_token_exp": 0
},
"created_at": 0,
"id": "id",
"meta": {
"color": "color",
"thumbnail": "thumbnail"
},
"name": "name"
}
 
application/json

Delete a Workspace

Delete a Workspace

delete
{protocol}://{hostname}:{port}{path}/workspaces/{workspace_id_or_name}

Query Parameters

cascadeboolean

The cascade option lets you delete a workspace and all of its entities in one request.

Example:true

Path Parameters

workspace_id_or_namestringrequired

ID or name of the workspace to look up.

Example:2747d1e5-8246-4f65-a939-b392f1ee17f8

Response

Successfully deleted Workspace or the resource didn’t exist

delete/workspaces/{workspace_id_or_name}