Applications

Create and manage applications in the tenant.

Get a list of applications.

get

Retrieve a list of applications.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Responses

200

Executed successfully.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get

/api/v1/apps

HTTPcURLJavaScriptPython

GET /api/v1/apps HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "name": "app123",
    "createdBy": "[email protected]",
    "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

bearerAuth

AuthorizationstringRequired

Bearer authentication

Body

application/json

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

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

409

The specified resource already exists

application/json

500

unexpected error

application/json

503

unexpected error

application/json

post

/api/v1/apps

HTTPcURLJavaScriptPython

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 application by id.

get

Retrieve the details of an application by id.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

appIdstringRequired

The application id to retrieve

Responses

200

Executed successfully.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get

/api/v1/apps/{appId}

HTTPcURLJavaScriptPython

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

{
  "name": "app123",
  "createdBy": "[email protected]",
  "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

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

appIdstringRequired

The application id to retrieve

Responses

204

Executed successfully.

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

delete

/api/v1/apps/{appId}

HTTPcURLJavaScriptPython

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

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

appIdstringRequired

The application id to retrieve

Body

application/json

enabledbooleanRequired

Responses

200

Executed successfully.

No content

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

patch

/api/v1/apps/{appId}

HTTPcURLJavaScriptPython

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

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

appIdstringRequired

The application id to retrieve

Responses

200

Regenerated successfully.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

post

/api/v1/apps/{appId}/secret

HTTPcURLJavaScriptPython

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

{
  "secret": "189ej2ijd92fj092k049fk0"
}