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

Settings

View and manage configuration settings for your organization.

Get security settings

get
Authorizations
AuthorizationstringRequired

Bearer authentication

Responses
200

Executed successfully.

application/json
get/api/v1/security/settings
GET /api/v1/security/settings HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "autoRedirectSSO": {
    "value": {
      "enabled": false,
      "idpAlias": "oidc"
    },
    "displayName": "Auto Redirect SSO",
    "description": "Automatically redirect users to the SSO login page after logging in to the application"
  },
  "browserSessionTimeout": {
    "value": {
      "idleTimeout": 0
    },
    "displayName": "Browser Session Timeout",
    "description": "The idle timeout duration in minutes for browser sessions"
  },
  "logoutRedirectUri": {
    "value": {
      "uri": "https://example.com/logout-success"
    },
    "displayName": "Logout Redirect URI",
    "description": "The URI where users will be redirected after logging out of the application"
  }
}

Get security setting by key

get
Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
keystring · enumRequired

The settings key

Possible values:
Responses
200

Executed successfully.

application/json
Other propertiesanyOptional
get/api/v1/security/settings/{key}
GET /api/v1/security/settings/{key} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "value": {
    "enabled": false,
    "idpAlias": "oidc"
  },
  "displayName": "Auto Redirect SSO",
  "description": "Automatically redirect users to the SSO login page after logging in to the application"
}

Update security setting by key

put
Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
keystring · enumRequired

The settings key

Possible values:
Body
or
or
Responses
200

Setting successfully updated

No content
put/api/v1/security/settings/{key}
PUT /api/v1/security/settings/{key} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "enabled": false,
  "idpAlias": "oidc"
}
No content

Get workloads settings

get
Authorizations
AuthorizationstringRequired

Bearer authentication

Responses
200

Executed successfully.

application/json
get/api/v2/workloads/settings
GET /api/v2/workloads/settings HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "yamlSubmission": {
    "enabled": false
  }
}

Get workloads setting by key

get
Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
keystring · enumRequired

The settings key

Possible values:
Responses
200

Executed successfully.

application/json
enabledboolean · nullableOptional
get/api/v2/workloads/settings/{key}
GET /api/v2/workloads/settings/{key} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "enabled": false
}

Update workloads setting by key

put
Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
keystring · enumRequired

The settings key

Possible values:
Body
enabledboolean · nullableOptional
Responses
200

Setting successfully updated

No content
put/api/v2/workloads/settings/{key}
PUT /api/v2/workloads/settings/{key} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "enabled": false
}
No content
PreviousMeNextOrg Unit

Last updated