Version 2.20 has reached end of support. Upgrade to a newer supported version.
Ctrlk
Contact support
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Applications

Create and manage applications in the tenant.

Deprecated

Get Apps list.

get

Return the list of apps of the tenant. Deprecated in favor of the new endpoint api/v1/apps.

Authorizations
AuthorizationstringRequired

Bearer authentication

Query parameters
onlyCreatedByMebooleanOptional

Filter the returned entities to only those that created by the requesting subject

Responses
200

The complete set of permissions.

application/json
and
anyOptional
and
get/v1/k8s/apps
GET /v1/k8s/apps HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "entityType": "regular-user",
    "tenantId": 1001,
    "userId": "4008188b-ab50-4aa5-a3f2-b78091ccf92d",
    "permitAllClusters": false,
    "permittedClusters": [
      "71f69d83-ba66-4822-adf5-55ce55efd210"
    ],
    "roles": [
      "viewer"
    ],
    "createdAt": "2021-12-14T16:04:15.099Z"
  },
  null,
  {
    "clientId": "6d2894ba-f998-4039-bba1-caba57caf681",
    "name": "MyApplication",
    "revoked": false
  }
]
Deprecated

Create a new app.

post

Create a new app and assign it with a client secret. This endpoint requires ADMIN role. Deprecated in favor of the new endpoint api/v1/apps.

Authorizations
AuthorizationstringRequired

Bearer authentication

Body
and
anyOptional
and
Responses
200

The complete set of permissions.

application/json
and
anyOptional
and
post/v1/k8s/apps
POST /v1/k8s/apps HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 327

{
  "entityType": "regular-user",
  "tenantId": 1001,
  "userId": "4008188b-ab50-4aa5-a3f2-b78091ccf92d",
  "permitAllClusters": false,
  "permittedClusters": [
    "71f69d83-ba66-4822-adf5-55ce55efd210"
  ],
  "roles": [
    "viewer"
  ],
  "createdAt": "2021-12-14T16:04:15.099Z",
  "clientId": "6d2894ba-f998-4039-bba1-caba57caf681",
  "name": "MyApplication",
  "revoked": false
}
{
  "entityType": "regular-user",
  "tenantId": 1001,
  "userId": "4008188b-ab50-4aa5-a3f2-b78091ccf92d",
  "permitAllClusters": false,
  "permittedClusters": [
    "71f69d83-ba66-4822-adf5-55ce55efd210"
  ],
  "roles": [
    "viewer"
  ],
  "createdAt": "2021-12-14T16:04:15.099Z",
  "clientId": "6d2894ba-f998-4039-bba1-caba57caf681",
  "name": "MyApplication",
  "revoked": false
}
Deprecated

Get app details.

get

Get the details of a given app. This endpoint requires ADMIN, EDITOR or VIEWER role. Deprecated in favor of the new endpoint api/v1/apps/{clientId}.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
clientIdstring · uuidRequired

Unique identifier of the app

Example: 4008188b-ab50-4aa5-a3f2-b78091ccf92d
Responses
200

App details.

application/json
and
anyOptional
and
get/v1/k8s/apps/{clientId}
GET /v1/k8s/apps/{clientId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "entityType": "regular-user",
  "tenantId": 1001,
  "userId": "4008188b-ab50-4aa5-a3f2-b78091ccf92d",
  "permitAllClusters": false,
  "permittedClusters": [
    "71f69d83-ba66-4822-adf5-55ce55efd210"
  ],
  "roles": [
    "viewer"
  ],
  "createdAt": "2021-12-14T16:04:15.099Z",
  "clientId": "6d2894ba-f998-4039-bba1-caba57caf681",
  "name": "MyApplication",
  "revoked": false
}
Deprecated

Update app details.

put

Update the details of a given app. This endpoint requires ADMIN role. Deprecated in favor of the new endpoint api/v1/apps/{clientId}.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
clientIdstring · uuidRequired

Unique identifier of the app

Example: 4008188b-ab50-4aa5-a3f2-b78091ccf92d
Body
and
anyOptional
and
Responses
200

User updated successfully

application/json
and
anyOptional
and
put/v1/k8s/apps/{clientId}
PUT /v1/k8s/apps/{clientId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 327

{
  "entityType": "regular-user",
  "tenantId": 1001,
  "userId": "4008188b-ab50-4aa5-a3f2-b78091ccf92d",
  "permitAllClusters": false,
  "permittedClusters": [
    "71f69d83-ba66-4822-adf5-55ce55efd210"
  ],
  "roles": [
    "viewer"
  ],
  "createdAt": "2021-12-14T16:04:15.099Z",
  "clientId": "6d2894ba-f998-4039-bba1-caba57caf681",
  "name": "MyApplication",
  "revoked": false
}
{
  "entityType": "regular-user",
  "tenantId": 1001,
  "userId": "4008188b-ab50-4aa5-a3f2-b78091ccf92d",
  "permitAllClusters": false,
  "permittedClusters": [
    "71f69d83-ba66-4822-adf5-55ce55efd210"
  ],
  "roles": [
    "viewer"
  ],
  "createdAt": "2021-12-14T16:04:15.099Z",
  "clientId": "6d2894ba-f998-4039-bba1-caba57caf681",
  "name": "MyApplication",
  "revoked": false
}
Deprecated

Delete a App.

delete

Delete the given app from the tenant. This endpoint requires ADMIN role. Deprecated in favor of the new endpoint api/v1/apps/{clientId}.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
clientIdstring · uuidRequired

Unique identifier of the app

Example: 4008188b-ab50-4aa5-a3f2-b78091ccf92d
Responses
200

User deleted successfully.

No content
delete/v1/k8s/apps/{clientId}
DELETE /v1/k8s/apps/{clientId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content
Deprecated

Re-generate secret of application.

post

Generate a new secret for a given application. This endpoint requires ADMIN role. Deprecated in favor of the new endpoint api/v1/apps/{clientId}/secret.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
clientIdstring · uuidRequired

Unique identifier of the app

Example: 4008188b-ab50-4aa5-a3f2-b78091ccf92d
Responses
200

The secret generated succefully

application/json
and
anyOptional
and
post/v1/k8s/apps/{clientId}/secret
POST /v1/k8s/apps/{clientId}/secret HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "entityType": "regular-user",
  "tenantId": 1001,
  "userId": "4008188b-ab50-4aa5-a3f2-b78091ccf92d",
  "permitAllClusters": false,
  "permittedClusters": [
    "71f69d83-ba66-4822-adf5-55ce55efd210"
  ],
  "roles": [
    "viewer"
  ],
  "createdAt": "2021-12-14T16:04:15.099Z",
  "clientId": "6d2894ba-f998-4039-bba1-caba57caf681",
  "name": "MyApplication",
  "revoked": false
}

Get a list of applications.

get

Retrieve a list of applications.

Authorizations
AuthorizationstringRequired

Bearer authentication

Responses
200

Executed successfully.

application/json
namestringRequired
createdBystringRequired
createdAtstring · date-time · nullableRequired
updatedAtstring · date-time · nullableRequired
enabledbooleanRequired
tenantIdstringOptional
lastLoginstring · date-time · nullableRequired
idstringRequired
clientIdstringRequired
get/api/v1/apps
GET /api/v1/apps HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "name": "app123",
    "createdBy": "test@run.ai",
    "createdAt": "2020-01-01T00:00:00Z",
    "updatedAt": "2020-01-01T00:00:00Z",
    "enabled": true,
    "tenantId": 1234567890,
    "lastLogin": "2020-01-01T00:00:00Z",
    "id": "3434c-12323ab-4ce2ea6-b44fc-db344d",
    "clientId": "app123"
  }
]

Create an application.

post

Used to create an application.

Authorizations
AuthorizationstringRequired

Bearer authentication

Body
namestringRequired

The name of the application. The name must be unique within the organization and can only contain lowercase alphanumeric characters and hyphens. It must start and end with a letter.

Pattern: ^[a-z][-_a-z0-9]*[a-z0-9]$
Responses
201

Executed successfully.

application/json
idstringRequired
namestringRequired
secretstringRequired
clientIdstringOptional
post/api/v1/apps
POST /api/v1/apps HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "name": "app-123"
}
{
  "id": "0eeaf222-e503-4f35-9d9c-c419816272e3",
  "name": "app123",
  "secret": "asdasidjn9d",
  "clientId": "app123"
}

Get a list of installer applications.

get

Retrieve a list of installer applications.

Authorizations
AuthorizationstringRequired

Bearer authentication

Responses
200

Executed successfully.

application/json
idstringRequired
namestringRequired
secretstringRequired
clientIdstringOptional
get/api/v1/apps/installer
GET /api/v1/apps/installer HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "0eeaf222-e503-4f35-9d9c-c419816272e3",
  "name": "app123",
  "secret": "asdasidjn9d",
  "clientId": "app123"
}

Get application by id.

get

Retrieve the details of an application by id.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
appIdstringRequired

The application id to retrieve

Responses
200

Executed successfully.

application/json
namestringRequired
createdBystringRequired
createdAtstring · date-time · nullableRequired
updatedAtstring · date-time · nullableRequired
enabledbooleanRequired
tenantIdstringOptional
lastLoginstring · date-time · nullableRequired
idstringRequired
clientIdstringRequired
get/api/v1/apps/{appId}
GET /api/v1/apps/{appId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "app123",
  "createdBy": "test@run.ai",
  "createdAt": "2020-01-01T00:00:00Z",
  "updatedAt": "2020-01-01T00:00:00Z",
  "enabled": true,
  "tenantId": 1234567890,
  "lastLogin": "2020-01-01T00:00:00Z",
  "id": "3434c-12323ab-4ce2ea6-b44fc-db344d",
  "clientId": "app123"
}

Delete an application by id.

delete

Use to delete an application by id.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
appIdstringRequired

The application id to retrieve

Responses
204

Executed successfully.

No content
delete/api/v1/apps/{appId}
DELETE /api/v1/apps/{appId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update application details by id.

patch

Use to update the details of an application by id.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
appIdstringRequired

The application id to retrieve

Body
enabledbooleanRequired
Responses
200

Executed successfully.

No content
patch/api/v1/apps/{appId}
PATCH /api/v1/apps/{appId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "enabled": true
}
No content

Regenerate an application secret.

post

Use to regenerate the application secret by id.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
appIdstringRequired

The application id to retrieve

Responses
200

Regenerated successfully.

application/json
secretstringOptional
post/api/v1/apps/{appId}/secret
POST /api/v1/apps/{appId}/secret HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "secret": "189ej2ijd92fj092k049fk0"
}
PreviousPermissions
NextRoles

Last updated