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 cluster settings

get
Authorizations
AuthorizationstringRequired

Bearer authentication

Responses
200

Executed successfully.

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

{
  "enableAdvancedGpuMetrics": {
    "enabled": false
  }
}

Get cluster 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
displayNamestringRead-onlyOptional
descriptionstringRead-onlyOptional
stagestringRead-onlyOptional
get/api/v1/clusters/settings/{key}
GET /api/v1/clusters/settings/{key} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "enabled": false
}

Update cluster 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/v1/clusters/settings/{key}
PUT /api/v1/clusters/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

Get node pool settings

get
Authorizations
AuthorizationstringRequired

Bearer authentication

Responses
200

Executed successfully.

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

{
  "projectManualOverQuota": {
    "enabled": false
  },
  "cpuResourcesQuota": {
    "enabled": false
  }
}

Get node pool 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
displayNamestringRead-onlyOptional
descriptionstringRead-onlyOptional
stagestringRead-onlyOptional
get/api/v1/node-pools/settings/{key}
GET /api/v1/node-pools/settings/{key} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "enabled": false
}

Update node pool 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/v1/node-pools/settings/{key}
PUT /api/v1/node-pools/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

Get authorization settings

get
Authorizations
AuthorizationstringRequired

Bearer authentication

Responses
200

Executed successfully.

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

{
  "enableScopedAuthorization": {
    "enabled": false
  },
  "tenantIsCspManaged": {
    "enabled": false
  }
}

Get authorization 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/v1/authorization/settings/{key}
GET /api/v1/authorization/settings/{key} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "enabled": false
}

Update authorization 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/v1/authorization/settings/{key}
PUT /api/v1/authorization/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

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 all workloads settings.

get

Retrieve the current values of all workloads-related settings for the tenant.

Authorizations
AuthorizationstringRequired

Bearer authentication

Responses
200

Request completed successfully.

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

{
  "enablePolicies": {
    "value": {
      "enabled": true
    },
    "displayName": "text",
    "description": "text",
    "stage": "text"
  },
  "workloadSubmissionV2Enabled": {
    "value": {
      "enabled": true
    },
    "displayName": "text",
    "description": "text",
    "stage": "text"
  },
  "enableTemplatesV2": {
    "value": {
      "enabled": true
    },
    "displayName": "text",
    "description": "text",
    "stage": "text"
  },
  "enableHybridSubmission": {
    "value": {
      "enabled": true
    },
    "displayName": "text",
    "description": "text",
    "stage": "text"
  },
  "gpuOverProvisioning": {
    "value": {
      "enabled": true
    },
    "displayName": "text",
    "description": "text",
    "stage": "text"
  },
  "applicationSubmission": {
    "value": {
      "enabled": true
    },
    "displayName": "text",
    "description": "text",
    "stage": "text"
  }
}

Get a workloads setting by key.

get

Retrieve the current value of a specific workloads setting by its key.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
keystring · enumRequiredPossible values:
Responses
200

Request completed successfully.

application/json
displayNamestringRead-onlyOptional
descriptionstringRead-onlyOptional
stagestringRead-onlyOptional
get/api/v1/workloads/settings/{key}
GET /api/v1/workloads/settings/{key} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "value": {
    "enabled": true
  },
  "displayName": "text",
  "description": "text",
  "stage": "text"
}

Update a workloads setting by key.

put

Update the value of a specific workloads setting by its key.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
keystring · enumRequiredPossible values:
Body
enabledboolean · nullableOptional
Responses
200

Request completed successfully.

application/json
enabledboolean · nullableOptional
put/api/v1/workloads/settings/{key}
PUT /api/v1/workloads/settings/{key} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "enabled": true
}
{
  "enabled": true
}

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": {
    "value": {
      "enabled": true
    },
    "displayName": "text",
    "description": "text",
    "stage": "text"
  }
}

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
displayNamestringRead-onlyOptional
descriptionstringRead-onlyOptional
stagestringRead-onlyOptional
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

Get datavolumes settings

get
Authorizations
AuthorizationstringRequired

Bearer authentication

Responses
200

Executed successfully.

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

{
  "enableDataVolumes": {
    "value": {
      "enabled": true
    },
    "displayName": "text",
    "description": "text",
    "stage": "text"
  }
}

Get datavolumes setting by key

get
Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
keystring · enumRequired

The settings key

Possible values:
Responses
200

Executed successfully.

application/json
displayNamestringRead-onlyOptional
descriptionstringRead-onlyOptional
stagestringRead-onlyOptional
get/api/v1/datavolumes/settings/{key}
GET /api/v1/datavolumes/settings/{key} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "enabled": true
}

Update datavolumes 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/v1/datavolumes/settings/{key}
PUT /api/v1/datavolumes/settings/{key} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "enabled": true
}
No content

Get notifications settings

get

Returns all notifications-related settings for the tenant.

Authorizations
AuthorizationstringRequired

Bearer authentication

Responses
200

Executed successfully.

application/json

Aggregated response containing all notifications settings configured for the tenant

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

{
  "adminMessage": {
    "value": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "msg": "System maintenance scheduled for this weekend",
      "createdAt": 1706886400000,
      "enableDismiss": true
    },
    "displayName": "Admin message",
    "description": "Write a message that will be displayed to all users"
  }
}

Get notifications setting by key

get

Returns a single notifications setting identified by the path key.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
keystring · enumRequired

Identifier of the notifications setting to retrieve or update.

Possible values:
Responses
200

Executed successfully.

application/json
object · GetSettingResponseOptional

Dynamic settings response that varies by setting key

get/api/v1/notifications/settings/{key}
GET /api/v1/notifications/settings/{key} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "value": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "msg": "System maintenance scheduled",
    "createdAt": 1706886400000,
    "enableDismiss": true
  },
  "displayName": "Admin message",
  "description": "Write a message that will be displayed to all users"
}

Update notifications setting by key

put

Updates a single notifications setting identified by the path key.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
keystring · enumRequired

Identifier of the notifications setting to retrieve or update.

Possible values:
Body
Responses
200

Setting successfully updated

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

{
  "msg": "System maintenance scheduled for this weekend",
  "enableDismiss": true
}
No content

Get branding settings

get

Returns all branding-related settings for the tenant.

Authorizations
AuthorizationstringRequired

Bearer authentication

Responses
200

Executed successfully.

application/json

Aggregated response containing all branding settings configured for the tenant

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

{
  "logo": {
    "value": {
      "logo": "<base64-encoded-image>"
    },
    "displayName": "Logo",
    "description": "Retrieve the base64 logo file."
  }
}

Get branding setting by key

get

Returns a single branding setting identified by the path key.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
keystring · enumRequired

Identifier of the branding setting to retrieve or update

Possible values:
Responses
200

Executed successfully.

application/json
object · GetSettingResponseOptional

Dynamic settings response that varies by setting key

get/api/v1/branding/settings/{key}
GET /api/v1/branding/settings/{key} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "value": {
    "logo": "<base64-encoded-image>"
  },
  "displayName": "Logo",
  "description": "Retrieve the base64 logo file."
}

Update branding setting by key

put

Updates a single branding setting identified by the path key.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
keystring · enumRequired

Identifier of the branding setting to retrieve or update

Possible values:
Body
Responses
200

Setting successfully updated.

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

{
  "logo": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mP8/x8AAwMCAO+V4nEAAAAASUVORK5CYII="
}
No content
PreviousNVIDIA Run:ai API PolicyNextClusters

Last updated