Ctrlk
Contact support
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Applications

DEPRECATED: Applications have been renamed to Service Accounts. Please use the Service Accounts endpoints instead.

Create and manage applications in the tenant.

Deprecated

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"
  }
]
Deprecated

Create an application.

post

Used to create an application.

Authorizations
AuthorizationstringRequired

Bearer authentication

Body
namestring · min: 2 · max: 255Required

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"
}
Deprecated

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"
}
Deprecated

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
Deprecated

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
Deprecated

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
NextService Accounts

Last updated