openapi: 3.0.3 info: contact: email: support@aptible.com description: REST API for the core Aptible platform. title: Aptible API v1 version: v1 servers: - url: "{baseUrl}" variables: baseUrl: default: https://api.aptible.com description: Override for local or test environments security: - token: [] tags: - name: Accounts - name: ActivityReports - name: Apps - name: BackupRetentionPolicies - name: Backups - name: Claims - name: Certificates - name: CodeScanResults - name: Configurations - name: Containers - name: DatabaseCredentials - name: DatabaseImages - name: Databases - name: Deployments - name: DiskAttachments - name: Disks - name: EphemeralContainers - name: EphemeralSessions - name: Images - name: IntrusionDetectionReports - name: LlmGatewayConfigurations - name: LlmGatewayKeys - name: LlmKeys - name: LlmPolicies - name: LogDrains - name: Maintenances - name: MaintenanceWindows - name: MetricDrains - name: Operations - name: Permissions - name: PersistentDisks - name: Plans - name: PrereleaseCommands - name: Releases - name: Root - name: ServiceDefinitions - name: ServiceSizingPolicies - name: Services - name: Settings - name: Sources - name: SshPortalConnections - name: Stacks - name: Vhosts - name: VpcPeers - name: VpnTunnels paths: /stacks/{stack_id}/accounts: get: description: Returns a paginated list of accounts belonging to the specified stack. operationId: ListAccountsForStack parameters: - description: stack_id explode: false in: path name: stack_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListAccountsForStack_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list accounts tags: - Accounts /accounts: get: description: Returns a paginated list of all accounts. operationId: ListAccounts parameters: - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListAccountsForStack_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list accounts tags: - Accounts post: description: Creates a new account within the organization. operationId: CreateAccount parameters: - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAccount_request' responses: "201": content: application/hal+json: schema: $ref: '#/components/schemas/account' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: create account tags: - Accounts /accounts/{id}: delete: description: Deletes an account by ID. operationId: DeleteAccount parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple responses: "204": description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: delete account tags: - Accounts get: description: Returns the details of a specific account by ID. operationId: GetAccount parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/account' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: show account tags: - Accounts patch: description: Partially updates an account's attributes. operationId: PatchAccount parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchAccount_request' responses: "200": description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: update account tags: - Accounts put: description: Updates an account's attributes. operationId: UpdateAccount parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAccount_request' responses: "200": description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: update account tags: - Accounts /find/account: get: description: Returns the account matching the specified handle. operationId: GetAccountByHandle parameters: - description: account handle explode: true in: query name: handle required: true schema: type: string style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/account' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: find account by handle tags: - Accounts /accounts/{account_id}/activity_reports: get: description: Returns a paginated list of activity reports for the specified account. operationId: ListActivityReportsForAccount parameters: - description: account_id explode: false in: path name: account_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListActivityReportsForAccount_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list activity_reports tags: - ActivityReports /activity_reports/{activity_report_id}/download: get: description: Returns a presigned download URL for the specified activity report. operationId: GetActivityReportDownload parameters: - description: activity_report_id explode: false in: path name: activity_report_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": description: Presigned download URL default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: download activity_report tags: - ActivityReports /activity_reports/{id}: get: description: Returns the details of a specific activity report by ID. operationId: GetActivityReport parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/activity_report' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: show activity_report tags: - ActivityReports /accounts/{account_id}/apps: get: description: Returns a paginated list of apps belonging to the specified account. operationId: ListAppsForAccount parameters: - description: account_id explode: false in: path name: account_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListAppsForAccount_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list apps tags: - Apps post: description: Creates a new app within the specified account. operationId: CreateApp parameters: - description: account_id explode: false in: path name: account_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateApp_request' responses: "201": content: application/hal+json: schema: $ref: '#/components/schemas/app' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: create app tags: - Apps /apps: get: description: Returns a paginated list of all apps. operationId: ListApps parameters: - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListAppsForAccount_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list apps tags: - Apps /apps/{id}: delete: description: Deletes an app by ID. operationId: DeleteApp parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple responses: "204": description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: delete app tags: - Apps get: description: Returns the details of a specific app by ID. operationId: GetApp parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/app' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: show app tags: - Apps patch: description: Partially updates an app's attributes. operationId: PatchApp parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateApp_request' responses: "200": description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: update app tags: - Apps put: description: Updates an app's attributes. operationId: UpdateApp parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateApp_request' responses: "200": description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: update app tags: - Apps /certificates/{certificate_id}/apps: get: description: Returns a paginated list of apps using the specified certificate. operationId: ListAppsForCertificate parameters: - description: certificate_id explode: false in: path name: certificate_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListAppsForAccount_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list apps tags: - Apps /find/app: get: description: Returns the app matching the specified handle. operationId: GetAppByHandle parameters: - description: app handle explode: true in: query name: handle required: true schema: type: string style: form - description: account handle to disambiguate when multiple apps share the same handle explode: true in: query name: environment required: false schema: type: string style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/app' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: find app by handle tags: - Apps /accounts/{account_id}/backup_retention_policies: get: description: Returns a paginated list of backup retention policies for the specified account. operationId: ListBackupRetentionPoliciesForAccount parameters: - description: account_id explode: false in: path name: account_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListBackupRetentionPoliciesForAccount_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list backup retention policies tags: - BackupRetentionPolicies post: description: Creates a new backup retention policy for the specified account. operationId: CreateBackupRetentionPolicy parameters: - description: account_id explode: false in: path name: account_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateBackupRetentionPolicy_request' responses: "201": description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: create backup retention policy tags: - BackupRetentionPolicies /backup_retention_policies/{id}: get: description: Returns the details of a specific backup retention policy by ID. operationId: GetBackupRetentionPolicy parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/backup_retention_policy' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: show backup_retention_policy tags: - BackupRetentionPolicies /backups: get: description: Returns a paginated list of all backups. operationId: ListBackups parameters: - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: wether deleted records should be returned or not explode: true in: query name: with_deleted required: false schema: type: boolean style: form - description: "when true, only returns backups whose associated database has\ \ been deleted" explode: true in: query name: orphaned required: false schema: type: boolean style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListBackups_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list backups tags: - Backups /accounts/{account_id}/backups: get: description: Returns a paginated list of backups for the specified account. operationId: ListBackupsForAccount parameters: - description: account_id explode: false in: path name: account_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: wether deleted records should be returned or not explode: true in: query name: with_deleted required: false schema: type: boolean style: form - description: "when true, only returns backups whose associated database has\ \ been deleted" explode: true in: query name: orphaned required: false schema: type: boolean style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListBackups_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list backups tags: - Backups /databases/{database_id}/backups: get: description: Returns a paginated list of backups for the specified database. operationId: ListBackupsForDatabase parameters: - description: database_id explode: false in: path name: database_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: wether deleted records should be returned or not explode: true in: query name: with_deleted required: false schema: type: boolean style: form - description: "when true, only returns backups whose associated database has\ \ been deleted" explode: true in: query name: orphaned required: false schema: type: boolean style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListBackups_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list backups tags: - Backups /backups/{backup_id}/copies: get: description: Returns a paginated list of copies for the specified backup. operationId: ListCopiesForBackup parameters: - description: backup_id explode: false in: path name: backup_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: wether deleted records should be returned or not explode: true in: query name: with_deleted required: false schema: type: boolean style: form - description: "when true, only returns backups whose associated database has\ \ been deleted" explode: true in: query name: orphaned required: false schema: type: boolean style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListBackups_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list backups tags: - Backups /backups/{id}: get: description: Returns the details of a specific backup by ID. operationId: GetBackup parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/backup' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: show backup tags: - Backups /accounts/{account_id}/certificates: get: description: Returns a paginated list of certificates for the specified account. operationId: ListCertificatesForAccount parameters: - description: account_id explode: false in: path name: account_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListCertificatesForAccount_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list certificates tags: - Certificates post: description: Creates a new certificate for the specified account. operationId: CreateCertificate parameters: - description: account_id explode: false in: path name: account_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateCertificate_request' responses: "201": content: application/hal+json: schema: $ref: '#/components/schemas/certificate' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: create certificate tags: - Certificates /certificates/{id}: delete: description: Deletes a certificate by ID. operationId: DeleteCertificate parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple responses: "204": description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: delete certificate tags: - Certificates get: description: Returns the details of a specific certificate by ID. operationId: GetCertificate parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/certificate' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: show certificate tags: - Certificates patch: description: Partially updates a certificate's attributes. operationId: PatchCertificate parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchCertificate_request' responses: "200": description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: update certificate tags: - Certificates put: description: Updates a certificate's attributes. operationId: UpdateCertificate parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: properties: {} type: object responses: "200": description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: update certificate tags: - Certificates /accounts/{account_id}/claims/{type}: post: description: You do not need to invoke this directly. Reserves a handle operationId: CreateClaimForAccount parameters: - description: account_id explode: false in: path name: account_id required: true schema: type: integer style: simple - description: type explode: false in: path name: type required: true schema: type: string style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateApp_request' responses: "204": description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: create claim tags: - Claims /claims: post: description: You do not need to invoke this directly. Reserves a handle operationId: CreateClaim parameters: - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateClaim_request' responses: "204": description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: create claim tags: - Claims /claims/{type}: post: description: You do not need to invoke this directly. Reserves a handle operationId: CreateClaimForType parameters: - description: type explode: false in: path name: type required: true schema: type: string style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateClaimForType_request' responses: "204": description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: create claim tags: - Claims /apps/{app_id}/code_scan_results: get: description: Returns a paginated list of code scan results for the specified app. operationId: ListCodeScanResultsForApp parameters: - description: app_id explode: false in: path name: app_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListCodeScanResultsForApp_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list code_scan_results tags: - CodeScanResults post: description: Creates a new code scan result for the specified app. operationId: CreateCodeScanResult parameters: - description: app_id explode: false in: path name: app_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateCodeScanResult_request' responses: "201": content: application/hal+json: schema: $ref: '#/components/schemas/code_scan_result' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: create code_scan_result tags: - CodeScanResults /code_scan_results/{id}: delete: description: Deletes a code scan result by ID. operationId: DeleteCodeScanResult parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple responses: "204": description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: delete code_scan_result tags: - CodeScanResults get: description: Returns the details of a specific code scan result by ID. operationId: GetCodeScanResult parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/code_scan_result' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: show code_scan_result tags: - CodeScanResults /apps/{app_id}/configurations: get: description: Returns a paginated list of configurations for the specified app. operationId: ListConfigurationsForApp parameters: - description: app_id explode: false in: path name: app_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListConfigurationsForApp_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list configurations tags: - Configurations post: description: Creates a new configuration for the specified app. operationId: CreateConfigurationForApp parameters: - description: app_id explode: false in: path name: app_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateConfigurationForApp_request' responses: "201": content: application/hal+json: schema: $ref: '#/components/schemas/configuration' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: create configuration tags: - Configurations /databases/{database_id}/configurations: get: description: Returns a paginated list of configurations for the specified database. operationId: ListConfigurationsForDatabase parameters: - description: database_id explode: false in: path name: database_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListConfigurationsForApp_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list configurations tags: - Configurations post: description: Creates a new configuration for the specified database. operationId: CreateConfigurationForDatabase parameters: - description: database_id explode: false in: path name: database_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateConfigurationForApp_request' responses: "201": content: application/hal+json: schema: $ref: '#/components/schemas/configuration' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: create configuration tags: - Configurations /configurations/{id}: delete: description: Deletes a configuration by ID. operationId: DeleteConfiguration parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple responses: "204": description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: delete configuration tags: - Configurations get: description: Returns the details of a specific configuration by ID. operationId: GetConfiguration parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/configuration' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: show configuration tags: - Configurations /releases/{release_id}/containers: get: description: Returns a paginated list of containers for the specified release. operationId: ListContainersForRelease parameters: - description: release_id explode: false in: path name: release_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListContainersForRelease_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list containers tags: - Containers /containers/{id}: get: description: Returns the details of a specific container by ID. operationId: GetContainer parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/container' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: show container tags: - Containers /log_drains/{log_drain_id}/containers: get: description: Returns a paginated list of containers for the specified log drain. operationId: ListContainersForLogDrain parameters: - description: log_drain_id explode: false in: path name: log_drain_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListContainersForRelease_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list containers tags: - Containers /metric_drains/{metric_drain_id}/containers: get: description: Returns a paginated list of containers for the specified metric drain. operationId: ListContainersForMetricDrain parameters: - description: metric_drain_id explode: false in: path name: metric_drain_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListContainersForRelease_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list containers tags: - Containers /databases/{database_id}/database_credentials: get: description: Returns a paginated list of credentials for the specified database. operationId: ListDatabaseCredentialsForDatabase parameters: - description: database_id explode: false in: path name: database_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListDatabaseCredentialsForDatabase_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list database_credentials tags: - DatabaseCredentials /database_credentials/{id}: get: description: Returns the details of a specific database credential by ID. operationId: GetDatabaseCredential parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/database_credential' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: show database_credential tags: - DatabaseCredentials /database_images: get: description: Returns a paginated list of available database images. operationId: ListDatabaseImages parameters: - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListDatabaseImages_200_response' description: successful security: [] summary: list database_images tags: - Images /database_images/{id}: get: description: Returns the details of a specific database image by ID. operationId: GetDatabaseImage parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/database_image' description: successful security: [] summary: show database_image tags: - Images /accounts/{account_id}/databases: get: description: Returns a paginated list of databases belonging to the specified account. operationId: ListDatabasesForAccount parameters: - description: account_id explode: false in: path name: account_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListDatabasesForAccount_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list databases tags: - Databases post: description: Creates a new database within the specified account. operationId: CreateDatabase parameters: - description: account_id explode: false in: path name: account_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDatabase_request' responses: "201": content: application/hal+json: schema: $ref: '#/components/schemas/database' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: create database tags: - Databases /databases/{database_id}/dependents: get: description: Returns a paginated list of replica databases for the specified database. operationId: ListReplicasForDatabase parameters: - description: database_id explode: false in: path name: database_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListDatabasesForAccount_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list databases tags: - Databases /databases: get: description: Returns a paginated list of all databases. operationId: ListDatabases parameters: - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListDatabasesForAccount_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list databases tags: - Databases /databases/{id}: delete: description: Deletes a database by ID. operationId: DeleteDatabase parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "when true, returns a database even if it has been deleted" explode: true in: query name: with_deleted required: false schema: type: boolean style: form responses: "204": description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: delete database tags: - Databases get: description: Returns the details of a specific database by ID. operationId: GetDatabase parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "when true, returns a database even if it has been deleted" explode: true in: query name: with_deleted required: false schema: type: boolean style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/database' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: show database tags: - Databases patch: description: Partially updates a database's attributes. operationId: PatchDatabase parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "when true, returns a database even if it has been deleted" explode: true in: query name: with_deleted required: false schema: type: boolean style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDatabase_request' responses: "200": description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: update database tags: - Databases put: description: Updates a database's attributes. operationId: UpdateDatabase parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "when true, returns a database even if it has been deleted" explode: true in: query name: with_deleted required: false schema: type: boolean style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDatabase_request' responses: "200": description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: update database tags: - Databases /find/database: get: description: Returns the database matching the specified handle. operationId: GetDatabaseByHandle parameters: - description: database handle explode: true in: query name: handle required: true schema: type: string style: form - description: account handle to disambiguate when multiple databases share the same handle explode: true in: query name: environment required: false schema: type: string style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/database' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: find database by handle tags: - Databases /deployments: get: description: Returns a paginated list of all deployments. operationId: ListDeployments parameters: - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListDeployments_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list deployments tags: - Deployments /apps/{app_id}/deployments: get: description: Returns a paginated list of deployments for the specified app. operationId: ListDeploymentsForApp parameters: - description: app_id explode: false in: path name: app_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListDeployments_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list deployments tags: - Deployments /deployments/{id}: get: description: Returns the details of a specific deployment by ID. operationId: GetDeployment parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/deployment' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: show deployment tags: - Deployments /accounts/{account_id}/disk_attachments: get: description: Returns a paginated list of disk attachments for the specified account. operationId: ListDiskAttachmentsForAccount parameters: - description: account_id explode: false in: path name: account_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListDiskAttachmentsForAccount_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list disk attachments tags: - DiskAttachments /services/{service_id}/disk_attachments: get: description: Returns a paginated list of disk attachments for the specified service. operationId: ListDiskAttachmentsForService parameters: - description: service_id explode: false in: path name: service_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListDiskAttachmentsForService_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list disk attachments tags: - DiskAttachments /persistent_disks/{persistent_disk_id}/disk_attachments: get: description: Returns a paginated list of disk attachments for the specified persistent disk. operationId: ListDiskAttachmentsForPersistentDisk parameters: - description: persistent_disk_id explode: false in: path name: persistent_disk_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListDiskAttachmentsForPersistentDisk_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list disk attachments tags: - DiskAttachments /disk_attachments: get: description: Returns a paginated list of all disk attachments. operationId: ListDiskAttachments parameters: - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListDiskAttachments_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list disk attachments tags: - DiskAttachments /disk_attachments/{id}: get: description: Returns the details of a specific disk attachment by ID. operationId: GetDiskAttachment parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: include soft-deleted records explode: true in: query name: with_deleted required: false schema: type: boolean style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/disk_attachment' description: reports deprovisioned when soft-deleted default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: show disk attachment tags: - DiskAttachments /accounts/{account_id}/disks: get: description: Returns a paginated list of disks for the specified account. operationId: ListDisksForAccount parameters: - description: account_id explode: false in: path name: account_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListDisksForAccount_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list disks tags: - Disks /disks/{id}: get: description: Returns the details of a specific disk by ID. operationId: GetDisk parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/disk' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: show disk tags: - Disks /ephemeral_sessions/{ephemeral_session_id}/ephemeral_containers: get: description: Returns a paginated list of ephemeral containers for the specified ephemeral session. operationId: ListEphemeralContainersForEphemeralSession parameters: - description: ephemeral_session_id explode: false in: path name: ephemeral_session_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListEphemeralContainersForEphemeralSession_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list ephemeral_containers tags: - EphemeralContainers /ephemeral_containers/{id}: get: description: Returns the details of a specific ephemeral container by ID. operationId: GetEphemeralContainer parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ephemeral_container' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: show ephemeral_container tags: - EphemeralContainers /log_drains/{log_drain_id}/ephemeral_containers: get: description: Returns a paginated list of ephemeral containers for the specified log drain. operationId: ListEphemeralContainersForLogDrain parameters: - description: log_drain_id explode: false in: path name: log_drain_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListEphemeralContainersForEphemeralSession_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list ephemeral_containers tags: - EphemeralContainers /apps/{app_id}/ephemeral_sessions: get: description: Returns a paginated list of ephemeral sessions for the specified app. operationId: ListEphemeralSessionsForApp parameters: - description: app_id explode: false in: path name: app_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListEphemeralSessionsForApp_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list ephemeral_sessions tags: - EphemeralSessions /ephemeral_sessions/{id}: get: description: Returns the details of a specific ephemeral session by ID. operationId: GetEphemeralSession parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ephemeral_session' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: show ephemeral_session tags: - EphemeralSessions /operations/{operation_id}/ephemeral_sessions: get: description: Returns a paginated list of ephemeral sessions for the specified operation. operationId: ListEphemeralSessionsForOperation parameters: - description: operation_id explode: false in: path name: operation_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListEphemeralSessionsForApp_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list ephemeral_sessions tags: - EphemeralSessions /: get: description: Returns the root resource with links to top-level collections. operationId: GetRoot parameters: - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/GetRoot_200_response' description: successful summary: show home tags: - Root /apps/{app_id}/images: get: description: Returns a paginated list of images for the specified app. operationId: ListImagesForApp parameters: - description: app_id explode: false in: path name: app_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListImagesForApp_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list images tags: - Images /images/{id}: get: description: Returns the details of a specific image by ID. operationId: GetImage parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/image' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: show image tags: - Images /stacks/{stack_id}/intrusion_detection_reports: get: description: Returns a paginated list of intrusion detection reports for the specified stack. operationId: ListIntrustionDetectionReportsForStack parameters: - description: stack_id explode: false in: path name: stack_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListIntrustionDetectionReportsForStack_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list intrusion_detection_reports tags: - IntrusionDetectionReports /intrusion_detection_reports/{intrusion_report_id}/download_csv: get: description: Returns a presigned URL to download the intrusion detection report as CSV. operationId: GetIntrustionDetectionReportCsvDownload parameters: - description: intrusion_report_id explode: false in: path name: intrusion_report_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": description: Presigned URL default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: download_csv intrusion_detection_report tags: - IntrusionDetectionReports /intrusion_detection_reports/{intrusion_report_id}/download_pdf: get: description: Returns a presigned URL to download the intrusion detection report as PDF. operationId: GetIntrustionDetectionReportPdfDownload parameters: - description: intrusion_report_id explode: false in: path name: intrusion_report_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": description: Presigned URL default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: download_pdf intrusion_detection_report tags: - IntrusionDetectionReports /intrusion_detection_reports/{id}: get: description: Returns the details of a specific intrusion detection report by ID. operationId: GetIntrustionDetectionReport parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/intrusion_detection_report' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: show intrusion_detection_report tags: - IntrusionDetectionReports /llm_gateway_configurations: get: description: "Returns a list of LLM Gateway configurations, optionally filtered\ \ by organization." operationId: ListLlmGatewayConfigurations parameters: - description: Filter by organization ID explode: true in: query name: organization_id required: false schema: type: string style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListLlmGatewayConfigurations_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list llm_gateway_configurations tags: - LlmGatewayConfigurations post: description: "Enrolls an organization in the AI Gateway service, creating a\ \ new LLM Gateway configuration." operationId: CreateLlmGatewayConfiguration parameters: - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateLlmGatewayConfiguration_request' responses: "201": content: application/hal+json: schema: $ref: '#/components/schemas/llm_gateway_configuration' description: enrolled "200": content: application/hal+json: schema: $ref: '#/components/schemas/llm_gateway_configuration' description: already enrolled (idempotent) default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: enroll organization in AI Gateway tags: - LlmGatewayConfigurations /llm_gateway_configurations/access_request: post: description: | Records an organization's interest in an AI Gateway trial. Grants nothing: access is decided by a human afterwards, so a success response means the request was recorded, not that the gateway is usable. Available only while self-service enrollment is disabled; while it is enabled this returns 404 and the organization enrolls itself instead. operationId: CreateLlmGatewayAccessRequest parameters: - description: "The organization requesting access. Required unless the caller\ \ belongs to exactly one organization, in which case it is inferred from\ \ the token." explode: true in: query name: organization_id required: false schema: type: string style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "202": content: application/json: schema: type: object description: request recorded "204": description: "organization is already enrolled, so no request was recorded" default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: request AI Gateway access tags: - LlmGatewayConfigurations /llm_gateway_configurations/{id}: patch: description: Partially updates an LLM Gateway configuration's attributes. operationId: UpdateLlmGatewayConfiguration parameters: - description: LLM Gateway Configuration database ID explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateLlmGatewayConfiguration_request' responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/llm_gateway_configuration' description: successful "422": content: application/hal+json: schema: $ref: '#/components/schemas/error' description: spend_limit cannot be updated on a trial configuration default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: update llm_gateway_configuration tags: - LlmGatewayConfigurations /llm_gateway_keys: get: description: "Returns a paginated list of the LLM Gateway keys the caller can\ \ see, optionally filtered by organization." operationId: ListLlmGatewayKeys parameters: - description: Filter by organization ID explode: true in: query name: organization_id required: false schema: type: string style: form - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListLlmGatewayKeys_200_response' description: successful "403": content: application/hal+json: schema: $ref: '#/components/schemas/error' description: organization not enrolled default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list llm_gateway_keys tags: - LlmGatewayKeys post: description: | Creates a key for an organization. The secret token is returned in this response only and cannot be retrieved afterwards. operationId: CreateLlmGatewayKey parameters: - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateLlmGatewayKey_request' responses: "201": content: application/hal+json: schema: $ref: '#/components/schemas/llm_gateway_key' description: created "403": content: application/hal+json: schema: $ref: '#/components/schemas/error' description: "organization not enrolled, or the caller has not accepted\ \ the LLM usage agreement" "422": content: application/hal+json: schema: $ref: '#/components/schemas/error' description: invalid handle or spend_limit default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: create llm_gateway_key tags: - LlmGatewayKeys /llm_gateway_keys/{id}: delete: description: | Revokes the specified LLM Gateway key. Available to the organization's owners and to whoever created the key. Revoking a key that is already revoked returns it unchanged. operationId: RevokeLlmGatewayKey parameters: - description: LLM Gateway Key database ID explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/llm_gateway_key' description: successful "403": content: application/hal+json: schema: $ref: '#/components/schemas/error' description: "organization not enrolled, or the caller may not revoke this\ \ key" "404": content: application/hal+json: schema: $ref: '#/components/schemas/error' description: not found default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: revoke llm_gateway_key tags: - LlmGatewayKeys get: description: Returns the details of a specific LLM Gateway key by ID. operationId: GetLlmGatewayKey parameters: - description: LLM Gateway Key database ID explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/llm_gateway_key' description: successful "403": content: application/hal+json: schema: $ref: '#/components/schemas/error' description: organization not enrolled "404": content: application/hal+json: schema: $ref: '#/components/schemas/error' description: not found default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: show llm_gateway_key tags: - LlmGatewayKeys patch: description: | Changes a key's handle and/or spend_limit. Nothing else about a key can be changed. Available to the organization's owners and to whoever created the key. At least one of handle and spend_limit must be sent, and only what is sent changes. Sending a null or blank spend_limit removes the key's limit. operationId: UpdateLlmGatewayKey parameters: - description: LLM Gateway Key database ID explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateLlmGatewayKey_request' responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/llm_gateway_key' description: successful "400": content: application/hal+json: schema: $ref: '#/components/schemas/error' description: neither handle nor spend_limit was sent "403": content: application/hal+json: schema: $ref: '#/components/schemas/error' description: "organization not enrolled, or the caller may not update this\ \ key" "404": content: application/hal+json: schema: $ref: '#/components/schemas/error' description: not found "422": content: application/hal+json: schema: $ref: '#/components/schemas/error' description: "handle is blank or already used by another key in the organization,\ \ or spend_limit is negative or exceeds the organization's spend_limit" default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: update llm_gateway_key tags: - LlmGatewayKeys /accounts/{account_id}/llm_keys: get: description: Returns a list of LLM keys for the specified account. operationId: ListLlmKeysForAccount parameters: - description: account_id explode: false in: path name: account_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListLlmKeysForAccount_200_response' description: successful "403": content: application/hal+json: schema: $ref: '#/components/schemas/error' description: organization not enrolled default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list llm_keys tags: - LlmKeys /llm_keys/{id}: delete: description: Revokes and deletes the specified LLM key. operationId: RevokeLlmKey parameters: - description: LLM Key database ID explode: false in: path name: id required: true schema: type: integer style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/llm_key' description: successful "403": content: application/hal+json: schema: $ref: '#/components/schemas/error' description: organization not enrolled "404": content: application/hal+json: schema: $ref: '#/components/schemas/error' description: not found default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: revoke llm_key tags: - LlmKeys get: description: Returns the details of a specific LLM key by ID. operationId: GetLlmKey parameters: - description: LLM Key database ID explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/llm_key' description: successful "403": content: application/hal+json: schema: $ref: '#/components/schemas/error' description: organization not enrolled "404": content: application/hal+json: schema: $ref: '#/components/schemas/error' description: not found default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: show llm_key tags: - LlmKeys /llm_keys: get: description: Returns a paginated list of all LLM keys. operationId: ListLlmKeys parameters: - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListLlmKeys_200_response' description: successful "403": content: application/hal+json: schema: $ref: '#/components/schemas/error' description: organization not enrolled default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list all llm_keys tags: - LlmKeys /llm_keys/{id}/usage: get: description: Returns aggregated usage statistics for the specified LLM key over a date range. operationId: GetLlmKeyUsage parameters: - description: LLM Key database ID explode: false in: path name: id required: true schema: type: integer style: simple - description: Start date for the usage period (YYYY-MM-DD) explode: true in: query name: start_date required: true schema: type: string style: form - description: "End date for the usage period (YYYY-MM-DD, exclusive)" explode: true in: query name: end_date required: true schema: type: string style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/GetLlmKeyUsage_200_response' description: successful "400": content: application/hal+json: schema: $ref: '#/components/schemas/error' description: bad request "403": content: application/hal+json: schema: $ref: '#/components/schemas/error' description: organization not enrolled "404": content: application/hal+json: schema: $ref: '#/components/schemas/error' description: not found default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: get llm key usage tags: - LlmKeys /llm_keys/{id}/requests: get: description: Returns a paginated list of API requests made with the specified LLM key. operationId: GetLlmKeyRequests parameters: - description: LLM Key database ID explode: false in: path name: id required: true schema: type: integer style: simple - description: "Start date/time for filtering requests (ISO8601 format, YYYY-MM-DD\ \ or YYYY-MM-DDTHH:MM:SS). Cannot be more than 7 days ago." explode: true in: query name: start_time required: true schema: type: string style: form - description: "End date/time for filtering requests (ISO8601 format, YYYY-MM-DD\ \ or YYYY-MM-DDTHH:MM:SS)" explode: true in: query name: end_time required: true schema: type: string style: form - description: Page number for pagination explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results per page (max 50) explode: true in: query name: per_page required: false schema: type: integer style: form - description: Filter by specific request ID explode: true in: query name: request_id required: false schema: type: string style: form - description: Filter by request status ('success' or 'failure') explode: true in: query name: status required: false schema: type: string style: form - description: Filter by model name explode: true in: query name: model required: false schema: type: string style: form - description: "Sort field: 'spend', 'total_tokens', 'start_time', or 'end_time'.\ \ Default: 'start_time'" explode: true in: query name: sort_by required: false schema: type: string style: form - description: "Sort order: 'asc' or 'desc'. Default: 'desc'" explode: true in: query name: sort_order required: false schema: type: string style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/GetLlmKeyRequests_200_response' description: successful "422": content: application/hal+json: schema: $ref: '#/components/schemas/error' description: validation error "403": content: application/hal+json: schema: $ref: '#/components/schemas/error' description: organization not enrolled "404": content: application/hal+json: schema: $ref: '#/components/schemas/error' description: not found default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list llm key requests tags: - LlmKeys /accounts/{account_id}/llm_policies: get: description: Returns a list of LLM policies for the specified account. operationId: ListLlmPoliciesForAccount parameters: - description: account_id explode: false in: path name: account_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListLlmPoliciesForAccount_200_response' description: successful "403": content: application/hal+json: schema: $ref: '#/components/schemas/error' description: organization not enrolled default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list llm_policies for account tags: - LlmPolicies /llm_policies: get: description: Returns a paginated list of all LLM policies. operationId: ListLlmPolicies parameters: - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListLlmPolicies_200_response' description: successful "403": content: application/hal+json: schema: $ref: '#/components/schemas/error' description: organization not enrolled default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list all llm_policies tags: - LlmPolicies /llm_policies/{id}: get: description: Returns the details of a specific LLM policy by ID. operationId: GetLlmPolicy parameters: - description: LLM Policy database ID explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/llm_policy' description: successful "403": content: application/hal+json: schema: $ref: '#/components/schemas/error' description: organization not enrolled "404": content: application/hal+json: schema: $ref: '#/components/schemas/error' description: not found default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: show llm_policy tags: - LlmPolicies /llm_policies/{id}/usage: get: description: Returns aggregated usage statistics for the specified LLM policy over a date range. operationId: GetLlmPolicyUsage parameters: - description: LLM Policy database ID explode: false in: path name: id required: true schema: type: integer style: simple - description: Start date for the usage period (YYYY-MM-DD) explode: true in: query name: start_date required: true schema: type: string style: form - description: "End date for the usage period (YYYY-MM-DD, exclusive)" explode: true in: query name: end_date required: true schema: type: string style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/GetLlmKeyUsage_200_response' description: successful "400": content: application/hal+json: schema: $ref: '#/components/schemas/error' description: bad request "403": content: application/hal+json: schema: $ref: '#/components/schemas/error' description: organization not enrolled "404": content: application/hal+json: schema: $ref: '#/components/schemas/error' description: not found default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: get llm policy usage tags: - LlmPolicies /accounts/{account_id}/log_drains: get: description: Returns a paginated list of log drains for the specified account. operationId: ListLogDrainsForAccount parameters: - description: account_id explode: false in: path name: account_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListLogDrainsForAccount_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list log_drains tags: - LogDrains post: description: Creates a new log drain for the specified account. operationId: CreateLogDrain parameters: - description: account_id explode: false in: path name: account_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateLogDrain_request' responses: "201": content: application/hal+json: schema: $ref: '#/components/schemas/log_drain' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: create log_drain tags: - LogDrains /log_drains/{id}: delete: description: Deletes a log drain by ID. operationId: DeleteLogDrain parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple responses: "204": description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: delete log_drain tags: - LogDrains get: description: Returns the details of a specific log drain by ID. operationId: GetLogDrain parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/log_drain' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: show log_drain tags: - LogDrains patch: description: Partially updates a log drain's attributes. operationId: PatchLogDrain parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateLogDrain_request' responses: "200": description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: update log_drain tags: - LogDrains put: description: Updates a log drain's attributes. operationId: UpdateLogDrain parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateLogDrain_request' responses: "200": description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: update log_drain tags: - LogDrains /apps/{app_id}/maintenance_window: delete: description: Deletes the maintenance window for the specified app. operationId: DeleteMaintenanceWindowForApp parameters: - description: app_id explode: false in: path name: app_id required: true schema: type: integer style: simple responses: "204": description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: delete maintenance_window tags: - MaintenanceWindows get: description: Returns the maintenance window configured for the specified app. operationId: GetMaintenanceWindowForApp parameters: - description: app_id explode: false in: path name: app_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/maintenance_window' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: show maintenance_window tags: - MaintenanceWindows patch: description: Partially updates the maintenance window's attributes. operationId: PatchMaintenanceWindowForApp parameters: - description: app_id explode: false in: path name: app_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateMaintenanceWindowForApp_request' responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/maintenance_window' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: update maintenance_window tags: - MaintenanceWindows post: description: Creates the maintenance window for the specified app. operationId: CreateMaintenanceWindowForApp parameters: - description: app_id explode: false in: path name: app_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMaintenanceWindowForApp_request' responses: "201": content: application/hal+json: schema: $ref: '#/components/schemas/maintenance_window' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: create maintenance_window tags: - MaintenanceWindows put: description: Updates the maintenance window's attributes. operationId: UpdateMaintenanceWindowForApp parameters: - description: app_id explode: false in: path name: app_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateMaintenanceWindowForApp_request' responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/maintenance_window' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: update maintenance_window tags: - MaintenanceWindows /databases/{database_id}/maintenance_window: delete: description: Deletes the maintenance window for the specified database. operationId: DeleteMaintenanceWindowForDatabase parameters: - description: database_id explode: false in: path name: database_id required: true schema: type: integer style: simple responses: "204": description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: delete maintenance_window tags: - MaintenanceWindows get: description: Returns the maintenance window configured for the specified database. operationId: GetMaintenanceWindowForDatabase parameters: - description: database_id explode: false in: path name: database_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/maintenance_window' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: show maintenance_window tags: - MaintenanceWindows patch: description: Partially updates the maintenance window's attributes. operationId: PatchMaintenanceWindowForDatabase parameters: - description: database_id explode: false in: path name: database_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateMaintenanceWindowForApp_request' responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/maintenance_window' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: update maintenance_window tags: - MaintenanceWindows post: description: Creates the maintenance window for the specified database. operationId: CreateMaintenanceWindowForDatabase parameters: - description: database_id explode: false in: path name: database_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMaintenanceWindowForApp_request' responses: "201": content: application/hal+json: schema: $ref: '#/components/schemas/maintenance_window' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: create maintenance_window tags: - MaintenanceWindows put: description: Updates the maintenance window's attributes. operationId: UpdateMaintenanceWindowForDatabase parameters: - description: database_id explode: false in: path name: database_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateMaintenanceWindowForApp_request' responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/maintenance_window' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: update maintenance_window tags: - MaintenanceWindows /maintenance_windows/{id}: get: description: Returns the details of a specific maintenance window by ID. operationId: GetMaintenanceWindow parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/maintenance_window' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: show maintenance_window tags: - MaintenanceWindows /accounts/{account_id}/metric_drains: get: description: Returns a paginated list of metric drains for the specified account. operationId: ListMetricDrainsForAccount parameters: - description: account_id explode: false in: path name: account_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListMetricDrainsForAccount_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list metric_drains tags: - MetricDrains post: description: Creates a new metric drain for the specified account. operationId: CreateMetricDrain parameters: - description: account_id explode: false in: path name: account_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMetricDrain_request' responses: "201": content: application/hal+json: schema: $ref: '#/components/schemas/metric_drain' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: create metric_drain tags: - MetricDrains /maintenances/apps: get: description: Returns a paginated list of apps with their maintenance deadline info. operationId: GetMaintenanceApps parameters: - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/GetMaintenanceApps_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list apps with maintenance info tags: - Maintenances /maintenances/databases: get: description: Returns a paginated list of databases with their maintenance deadline info. operationId: GetMaintenanceDatabases parameters: - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/GetMaintenanceDatabases_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list databases with maintenance info tags: - Maintenances /metric_drains/{id}: get: description: Returns the details of a specific metric drain by ID. operationId: GetMetricDrain parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/metric_drain' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: show metric_drain tags: - MetricDrains /persistent_disks/{persistent_disk_id}/operations: get: description: Returns a paginated list of operations for the specified persistent disk. operationId: ListOperationsForPersistentDisk parameters: - description: persistent_disk_id explode: false in: path name: persistent_disk_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListOperationsForPersistentDisk_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list operations tags: - Operations post: description: Creates a new operation for the specified persistent disk. operationId: CreateOperationForPersistentDisk parameters: - description: persistent_disk_id explode: false in: path name: persistent_disk_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOperationRequest' responses: "201": content: application/hal+json: schema: $ref: '#/components/schemas/operation' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: create operation tags: - Operations /operations/{id}: get: description: Returns the details of a specific operation by ID. operationId: GetOperation parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/operation' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: show operation tags: - Operations patch: description: "Partially updates an operation's attributes, such as cancelling\ \ it." operationId: PatchOperation parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateOperation_request' responses: "200": description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: update operation tags: - Operations put: description: "Updates an operation's attributes, such as cancelling it." operationId: UpdateOperation parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateOperation_request' responses: "200": description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: update operation tags: - Operations /operations/{operation_id}/logs: get: description: Returns a presigned URL for downloading the logs of a completed operation. operationId: GetOperationLogs parameters: - description: operation_id explode: false in: path name: operation_id required: true schema: type: integer style: simple responses: "200": content: text/plain: schema: type: string description: Presigned download URL default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: get operation logs tags: - Operations /accounts/{account_id}/operations: get: description: Returns a paginated list of operations for the specified account. operationId: ListOperationsForAccount parameters: - description: account_id explode: false in: path name: account_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListOperationsForPersistentDisk_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list operations tags: - Operations /apps/{app_id}/operations: get: description: Returns a paginated list of operations for the specified app. operationId: ListOperationsForApp parameters: - description: app_id explode: false in: path name: app_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListOperationsForPersistentDisk_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list operations tags: - Operations post: description: Creates a new operation for the specified app. operationId: CreateOperationForApp parameters: - description: app_id explode: false in: path name: app_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOperationRequest' responses: "201": content: application/hal+json: schema: $ref: '#/components/schemas/operation' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: create operation tags: - Operations /ephemeral_sessions/{ephemeral_session_id}/operations: get: description: Returns a paginated list of operations for the specified ephemeral session. operationId: ListOperationsForEphemeralSession parameters: - description: ephemeral_session_id explode: false in: path name: ephemeral_session_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListOperationsForPersistentDisk_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list operations tags: - Operations post: description: Creates a new operation for the specified ephemeral session. operationId: CreateOperationForEphemeralSession parameters: - description: ephemeral_session_id explode: false in: path name: ephemeral_session_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOperationRequest' responses: "201": content: application/hal+json: schema: $ref: '#/components/schemas/operation' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: create operation tags: - Operations /databases/{database_id}/operations: get: description: Returns a paginated list of operations for the specified database. operationId: ListOperationsForDatabase parameters: - description: database_id explode: false in: path name: database_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListOperationsForPersistentDisk_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list operations tags: - Operations post: description: Creates a new operation for the specified database. operationId: CreateOperationForDatabase parameters: - description: database_id explode: false in: path name: database_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOperationRequest' responses: "201": content: application/hal+json: schema: $ref: '#/components/schemas/operation' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: create operation tags: - Operations /database_credentials/{database_credential_id}/operations: get: description: Returns a paginated list of operations for the specified database credential. operationId: ListOperationsForDatabaseCredential parameters: - description: database_credential_id explode: false in: path name: database_credential_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListOperationsForPersistentDisk_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list operations tags: - Operations post: description: Creates a new operation for the specified database credential. operationId: CreateOperationForDatabaseCredential parameters: - description: database_credential_id explode: false in: path name: database_credential_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOperationRequest' responses: "201": content: application/hal+json: schema: $ref: '#/components/schemas/operation' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: create operation tags: - Operations /services/{service_id}/operations: get: description: Returns a paginated list of operations for the specified service. operationId: ListOperationsForService parameters: - description: service_id explode: false in: path name: service_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListOperationsForPersistentDisk_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list operations tags: - Operations post: description: Creates a new operation for the specified service. operationId: CreateOperationForService parameters: - description: service_id explode: false in: path name: service_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOperationRequest' responses: "201": content: application/hal+json: schema: $ref: '#/components/schemas/operation' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: create operation tags: - Operations /vhosts/{vhost_id}/operations: get: description: Returns a paginated list of operations for the specified vhost. operationId: ListOperationsForVhost parameters: - description: vhost_id explode: false in: path name: vhost_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListOperationsForPersistentDisk_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list operations tags: - Operations post: description: Creates a new operation for the specified vhost. operationId: CreateOperationForVhost parameters: - description: vhost_id explode: false in: path name: vhost_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOperationRequest' responses: "201": content: application/hal+json: schema: $ref: '#/components/schemas/operation' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: create operation tags: - Operations /images/{image_id}/operations: get: description: Returns a paginated list of operations for the specified image. operationId: ListOperationsForImage parameters: - description: image_id explode: false in: path name: image_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListOperationsForPersistentDisk_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list operations tags: - Operations post: description: Creates a new operation for the specified image. operationId: CreateOperationForImage parameters: - description: image_id explode: false in: path name: image_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOperationRequest' responses: "201": content: application/hal+json: schema: $ref: '#/components/schemas/operation' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: create operation tags: - Operations /log_drains/{log_drain_id}/operations: get: description: Returns a paginated list of operations for the specified log drain. operationId: ListOperationsForLogDrain parameters: - description: log_drain_id explode: false in: path name: log_drain_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListOperationsForPersistentDisk_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list operations tags: - Operations post: description: Creates a new operation for the specified log drain. operationId: CreateOperationForLogDrain parameters: - description: log_drain_id explode: false in: path name: log_drain_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOperationRequest' responses: "201": content: application/hal+json: schema: $ref: '#/components/schemas/operation' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: create operation tags: - Operations /metric_drains/{metric_drain_id}/operations: get: description: Returns a paginated list of operations for the specified metric drain. operationId: ListOperationsForMetricDrain parameters: - description: metric_drain_id explode: false in: path name: metric_drain_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListOperationsForPersistentDisk_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list operations tags: - Operations post: description: Creates a new operation for the specified metric drain. operationId: CreateOperationForMetricDrain parameters: - description: metric_drain_id explode: false in: path name: metric_drain_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOperationRequest' responses: "201": content: application/hal+json: schema: $ref: '#/components/schemas/operation' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: create operation tags: - Operations /backups/{backup_id}/operations: get: description: Returns a paginated list of operations for the specified backup. operationId: ListOperationsForBackup parameters: - description: backup_id explode: false in: path name: backup_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListOperationsForPersistentDisk_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list operations tags: - Operations post: description: Creates a new operation for the specified backup. operationId: CreateOperationForBackup parameters: - description: backup_id explode: false in: path name: backup_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOperationRequest' responses: "201": content: application/hal+json: schema: $ref: '#/components/schemas/operation' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: create operation tags: - Operations /disk_attachments/{disk_attachment_id}/operations: get: description: Returns a paginated list of operations for the specified disk attachment. operationId: ListOperationsForDiskAttachment parameters: - description: disk_attachment_id explode: false in: path name: disk_attachment_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListOperationsForPersistentDisk_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list operations tags: - Operations post: description: Creates a new operation for the specified disk attachment. operationId: CreateOperationForDiskAttachment parameters: - description: disk_attachment_id explode: false in: path name: disk_attachment_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOperationRequest' responses: "201": content: application/hal+json: schema: $ref: '#/components/schemas/operation' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: create operation tags: - Operations /llm_gateway_keys/{llm_gateway_key_id}/operations: get: description: Returns a paginated list of operations for the specified LLM Gateway key. operationId: ListOperationsForLlmGatewayKey parameters: - description: llm_gateway_key_id explode: false in: path name: llm_gateway_key_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListOperationsForPersistentDisk_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list operations tags: - Operations /llm_keys/{llm_key_id}/operations: get: description: Returns a paginated list of operations for the specified LLM key. operationId: ListOperationsForLlmKey parameters: - description: llm_key_id explode: false in: path name: llm_key_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListOperationsForPersistentDisk_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list operations tags: - Operations /accounts/{account_id}/permissions: get: description: Returns a paginated list of permissions for the specified account. operationId: ListPermissionsForAccount parameters: - description: account_id explode: false in: path name: account_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListPermissionsForAccount_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list permissions tags: - Permissions post: description: Creates a new permission for a role on the specified account. operationId: CreatePermission parameters: - description: account_id explode: false in: path name: account_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePermission_request' responses: "201": content: application/hal+json: schema: $ref: '#/components/schemas/permission' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: create permission tags: - Permissions /permissions: get: description: Returns a paginated list of all permissions. operationId: ListPermissions parameters: - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListPermissionsForAccount_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list permissions tags: - Permissions /permissions/{id}: delete: description: Deletes a permission by ID. operationId: DeletePermission parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple responses: "204": description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: delete permission tags: - Permissions get: description: Returns the details of a specific permission by ID. operationId: GetPermission parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/permission' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: show permission tags: - Permissions /accounts/{account_id}/persistent_disks: get: description: Returns a paginated list of persistent disks for the specified account. operationId: ListPersistentDisksForAccount parameters: - description: account_id explode: false in: path name: account_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListPersistentDisksForAccount_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list persistent disks tags: - PersistentDisks /persistent_disks/{id}: get: description: Returns the details of a specific persistent disk by ID. operationId: GetPersistentDisk parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/persistent_disk' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: show persistent disk tags: - PersistentDisks /plans: get: description: Returns a paginated list of all available plans. operationId: ListPlans parameters: - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListPlans_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list plans tags: - Plans /plans/{id}: get: description: Returns the details of a specific plan by ID. operationId: GetPlan parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/plan' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: show plan tags: - Plans /services/{service_id}/releases: get: description: Returns a paginated list of releases for the specified service. operationId: ListReleasesForService parameters: - description: service_id explode: false in: path name: service_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListReleasesForService_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list releases tags: - Releases /releases/{id}: get: description: Returns the details of a specific release by ID. operationId: GetRelease parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/release' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: show release tags: - Releases /accounts/{account_id}/service_sizing_policies: get: description: Returns a paginated list of service sizing policies for the specified account. operationId: ListServiceSizingPoliciesForAccount parameters: - description: account_id explode: false in: path name: account_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListServiceSizingPoliciesForAccount_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list service_sizing_policies tags: - ServiceSizingPolicies /services/{service_id}/service_sizing_policies: get: description: Returns a paginated list of service sizing policies for the specified service. operationId: ListServiceSizingPoliciesForService parameters: - description: service_id explode: false in: path name: service_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListServiceSizingPoliciesForAccount_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list service_sizing_policies tags: - ServiceSizingPolicies post: description: Creates a new service sizing policy for the specified service. operationId: CreateServiceSizingPolicy parameters: - description: service_id explode: false in: path name: service_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateServiceSizingPolicy_request' responses: "201": description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: create service_sizing_policy tags: - ServiceSizingPolicies put: description: Updates a service sizing policy's attributes. operationId: UpdateServiceSizingPolicy parameters: - description: service_id explode: false in: path name: service_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateServiceSizingPolicy_request' responses: "200": description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: update service_sizing_policy tags: - ServiceSizingPolicies /services/{service_id}/service_sizing_policy: delete: description: Deletes the service sizing policy for the specified service. operationId: DeleteServiceSizingPolicy parameters: - description: service_id explode: false in: path name: service_id required: true schema: type: integer style: simple responses: "204": description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: delete service_sizing_policy tags: - ServiceSizingPolicies /service_sizing_policies/{id}: get: description: Returns the details of a specific service sizing policy by ID. operationId: GetServiceSizingPolicy parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/service_sizing_policy' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: show service_sizing_policy tags: - ServiceSizingPolicies /accounts/{account_id}/services: get: description: Returns a paginated list of services for the specified account. operationId: ListServicesForAccount parameters: - description: account_id explode: false in: path name: account_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListServicesForAccount_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list services tags: - Services /apps/{app_id}/services: get: description: Returns a paginated list of services for the specified app. operationId: ListServicesForApp parameters: - description: app_id explode: false in: path name: app_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListServicesForAccount_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list services tags: - Services /services/{id}: get: description: "Returns the details of a specific service, optionally including\ \ its current release operation status." operationId: GetServiceWithOperationStatus parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: Include release_operation_in_progress status explode: true in: query name: include_operation_status required: false schema: type: boolean style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/service' description: excludes operation status when param is not present default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: show service with operation status tags: - Services patch: description: Partially updates a service's attributes. operationId: PatchService parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateService_request' responses: "200": description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: update service tags: - Services put: description: Updates a service's attributes. operationId: UpdateService parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateService_request' responses: "200": description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: update service tags: - Services /apps/{app_id}/settings: get: description: Returns a paginated list of settings for the specified app. operationId: ListSettingsForApp parameters: - description: app_id explode: false in: path name: app_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListSettingsForApp_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list settings tags: - Settings post: description: Creates a new setting for the specified app. operationId: CreateSettingForApp parameters: - description: app_id explode: false in: path name: app_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSettingForApp_request' responses: "201": content: application/hal+json: schema: $ref: '#/components/schemas/setting' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: create setting tags: - Settings /databases/{database_id}/settings: get: description: Returns a paginated list of settings for the specified database. operationId: ListSettingsForDatabase parameters: - description: database_id explode: false in: path name: database_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListSettingsForApp_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list settings tags: - Settings post: description: Creates a new setting for the specified database. operationId: CreateSettingForDatabase parameters: - description: database_id explode: false in: path name: database_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSettingForApp_request' responses: "201": content: application/hal+json: schema: $ref: '#/components/schemas/setting' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: create setting tags: - Settings /services/{service_id}/settings: get: description: Returns a paginated list of settings for the specified service. operationId: ListSettingsForService parameters: - description: service_id explode: false in: path name: service_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListSettingsForApp_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list settings tags: - Settings post: description: Creates a new setting for the specified service. operationId: CreateSettingForService parameters: - description: service_id explode: false in: path name: service_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSettingForApp_request' responses: "201": content: application/hal+json: schema: $ref: '#/components/schemas/setting' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: create setting tags: - Settings /vhosts/{vhost_id}/settings: get: description: Returns a paginated list of settings for the specified vhost. operationId: ListSettingsForVhost parameters: - description: vhost_id explode: false in: path name: vhost_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListSettingsForApp_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list settings tags: - Settings post: description: Creates a new setting for the specified vhost. operationId: CreateSettingForVhost parameters: - description: vhost_id explode: false in: path name: vhost_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSettingForApp_request' responses: "201": content: application/hal+json: schema: $ref: '#/components/schemas/setting' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: create setting tags: - Settings /settings/{id}: get: description: Returns the details of a specific setting by ID. operationId: GetSetting parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/setting' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: show setting tags: - Settings /sources: get: description: Returns a paginated list of all sources accessible to the current user. operationId: ListSources parameters: - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListSources_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list sources tags: - Sources /sources/{id}: get: description: Returns the details of a specific source by ID. operationId: GetSource parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/source' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: show source tags: - Sources /sources/{source_id}/apps: get: description: Returns a paginated list of apps associated with the specified source. operationId: ListAppsForSource parameters: - description: source_id explode: false in: path name: source_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListAppsForSource_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list apps tags: - Sources /sources/{source_id}/deployments: get: description: Returns a paginated list of deployments associated with the specified source. operationId: ListDeploymentsForSource parameters: - description: source_id explode: false in: path name: source_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListDeploymentsForSource_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list deployments tags: - Sources /operations/{operation_id}/ssh_portal_connections: get: description: Returns a paginated list of SSH portal connections for the specified operation. operationId: ListSshPortalConnectionsForOperation parameters: - description: operation_id explode: false in: path name: operation_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListSshPortalConnectionsForOperation_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list ssh_portal_connections tags: - SshPortalConnections post: description: Creates a new SSH portal connection for the specified operation. operationId: CreateSshPortalConnection parameters: - description: operation_id explode: false in: path name: operation_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSshPortalConnection_request' responses: "201": content: application/hal+json: schema: $ref: '#/components/schemas/ssh_portal_connection' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: create ssh_portal_connection tags: - SshPortalConnections /ssh_portal_connections/{id}: get: description: Returns the details of a specific SSH portal connection by ID. operationId: GetSshPortalConnection parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ssh_portal_connection' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: show ssh_portal_connection tags: - SshPortalConnections /stacks: get: description: Returns a paginated list of all stacks accessible to the current user. operationId: ListStacks parameters: - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListStacks_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list stacks tags: - Stacks /stacks/{id}: get: description: Returns the details of a specific stack by ID. operationId: GetStack parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/stack' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: show stack tags: - Stacks /accounts/{account_id}/vhosts: get: description: Returns a paginated list of vhosts belonging to the specified account. operationId: ListVhostsForAccount parameters: - description: account_id explode: false in: path name: account_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListVhostsForAccount_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list vhosts tags: - Vhosts /apps/{app_id}/vhosts: get: description: Returns a paginated list of vhosts belonging to the specified app. operationId: ListVhostsForApp parameters: - description: app_id explode: false in: path name: app_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListVhostsForAccount_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list vhosts tags: - Vhosts /certificates/{certificate_id}/vhosts: get: description: Returns a paginated list of vhosts associated with the specified certificate. operationId: ListVhostsForCertificate parameters: - description: certificate_id explode: false in: path name: certificate_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListVhostsForAccount_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list vhosts tags: - Vhosts /services/{service_id}/vhosts: get: description: Returns a paginated list of vhosts belonging to the specified service. operationId: ListVhostsForService parameters: - description: service_id explode: false in: path name: service_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListVhostsForAccount_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list vhosts tags: - Vhosts post: description: Creates a new vhost for the specified service. operationId: CreateVhost parameters: - description: service_id explode: false in: path name: service_id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateVhost_request' responses: "201": content: application/hal+json: schema: $ref: '#/components/schemas/vhost' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: create vhost tags: - Vhosts /vhosts/{id}: delete: description: Deletes the specified vhost. operationId: DeleteVhost parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple responses: "204": description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: delete vhost tags: - Vhosts get: description: Returns the details of a specific vhost by ID. operationId: GetVhost parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/vhost' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: show vhost tags: - Vhosts patch: description: Partially updates a vhost's attributes. operationId: PatchVhost parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateVhost_request' responses: "200": description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: update vhost tags: - Vhosts put: description: Updates a vhost's attributes. operationId: UpdateVhost parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateVhost_request' responses: "200": description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: update vhost tags: - Vhosts /stacks/{stack_id}/vpc_peers: get: description: Returns a paginated list of VPC peers belonging to the specified stack. operationId: ListVpcPeersForStack parameters: - description: stack_id explode: false in: path name: stack_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListVpcPeersForStack_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list vpc_peers tags: - VpcPeers /vpc_peers/{id}: get: description: Returns the details of a specific VPC peer by ID. operationId: GetVpcPeer parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/vpc_peer' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: show vpc_peer tags: - VpcPeers /stacks/{stack_id}/vpn_tunnels: get: description: Returns a paginated list of VPN tunnels belonging to the specified stack. operationId: ListVpnTunnelsForStack parameters: - description: stack_id explode: false in: path name: stack_id required: true schema: type: integer style: simple - description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form - description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/ListVpnTunnelsForStack_200_response' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: list vpn_tunnels tags: - VpnTunnels /vpn_tunnels/{id}: get: description: Returns the details of a specific VPN tunnel by ID. operationId: GetVpnTunnel parameters: - description: id explode: false in: path name: id required: true schema: type: integer style: simple - description: "When true, omits embedded resources from the response. Also\ \ triggered when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form - description: "When set to no_sensitive_extras=true, omits sensitive fields\ \ and embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple responses: "200": content: application/hal+json: schema: $ref: '#/components/schemas/vpn_tunnel' description: successful default: content: application/hal+json: schema: $ref: '#/components/schemas/error' description: Error response. Often a 4xx or 5xx status code summary: show vpn_tunnel tags: - VpnTunnels components: parameters: page: description: Current page of paginated results explode: true in: query name: page required: false schema: type: integer style: form no_embed: description: "When true, omits embedded resources from the response. Also triggered\ \ when the Prefer: no_sensitive_extras=true header is present." explode: true in: query name: no_embed required: false schema: type: boolean style: form prefer: description: "When set to no_sensitive_extras=true, omits sensitive fields and\ \ embedded resources from the response." explode: false in: header name: Prefer required: false schema: enum: - no_sensitive_extras=true type: string style: simple per_page: description: Number of results to return per page explode: true in: query name: per_page required: false schema: type: integer style: form schemas: account: properties: id: type: integer type: type: string _type: type: string name: type: string x-nullable: true handle: type: string onboarding_status: type: string number: type: string activated: type: boolean syslog_host: type: string x-nullable: true syslog_port: type: integer x-nullable: true bastion_host: type: string x-nullable: true bastion_port: type: integer ssh_portal_port: type: integer x-nullable: true container_count: type: integer domain_count: type: integer total_disk_size: type: integer total_app_count: type: integer app_container_count: type: integer database_container_count: type: integer total_database_count: type: integer created_at: format: dateTime type: string updated_at: format: dateTime type: string sweetness_stack: type: string x-nullable: true gentlemanjerry_endpoint: type: string x-nullable: true gentlemanjerry_certificate: type: string x-nullable: true gentlemanjerry_docker_name: type: string x-nullable: true gentlemanjerry_instance_id: type: string x-nullable: true sweetness_stack_version: enum: - v1 - v2 type: string x-nullable: true ca_body: type: string x-nullable: true ca_private_key: type: string x-nullable: true _embedded: $ref: '#/components/schemas/account__embedded' _links: $ref: '#/components/schemas/account__links' required: - _embedded - _type - activated - app_container_count - bastion_host - bastion_port - ca_body - container_count - created_at - database_container_count - domain_count - gentlemanjerry_certificate - gentlemanjerry_docker_name - gentlemanjerry_endpoint - gentlemanjerry_instance_id - handle - id - name - number - onboarding_status - ssh_portal_port - sweetness_stack - sweetness_stack_version - syslog_host - syslog_port - total_app_count - total_database_count - total_disk_size - type - updated_at activity_report: properties: id: type: integer _type: type: string created_at: format: dateTime type: string updated_at: format: dateTime type: string starts_at: format: dateTime type: string ends_at: format: dateTime type: string filename: type: string _links: $ref: '#/components/schemas/activity_report__links' required: - _type - created_at - ends_at - filename - id - starts_at - updated_at app: properties: id: type: integer handle: type: string git_repo: type: string _type: type: string created_at: format: dateTime type: string updated_at: format: dateTime type: string status: type: string deployment_method: type: string x-nullable: true _embedded: $ref: '#/components/schemas/app__embedded' _links: $ref: '#/components/schemas/app__links' required: - _embedded - _type - created_at - deployment_method - git_repo - handle - id - status - updated_at backup_retention_policy: properties: id: type: integer _type: type: string created_at: format: dateTime type: string daily: type: integer monthly: type: integer yearly: type: integer pitr_days: type: integer make_copy: type: boolean keep_final: type: boolean _links: $ref: '#/components/schemas/backup_retention_policy__links' required: - _type - created_at - daily - id - keep_final - make_copy - monthly - pitr_days - yearly backup: properties: id: type: integer _type: type: string aws_snapshot_id: type: string aws_region: type: string database_handle: type: string created_at: format: dateTime type: string updated_at: format: dateTime type: string kms_arn: type: string x-nullable: true size: type: integer x-nullable: true manual: type: boolean x-nullable: true _embedded: $ref: '#/components/schemas/backup__embedded' _links: $ref: '#/components/schemas/backup__links' required: - _embedded - _type - aws_region - aws_snapshot_id - created_at - database_handle - id - kms_arn - manual - size - updated_at certificate: properties: id: type: integer _type: type: string certificate_body: type: string private_key: type: string common_name: type: string not_before: format: dateTime type: string not_after: format: dateTime type: string issuer_country: type: string issuer_organization: type: string issuer_website: type: string x-nullable: true issuer_common_name: type: string subject_country: type: string x-nullable: true subject_state: type: string x-nullable: true subject_locale: type: string x-nullable: true subject_organization: type: string x-nullable: true acme: type: boolean leaf_certificate: type: string certificate_chain: type: string sha256_fingerprint: type: string trusted: type: boolean self_signed: type: boolean certificate_arn: type: string x-nullable: true subject_alternative_names: items: type: string type: array private_key_algorithm: type: string created_at: format: dateTime type: string updated_at: format: dateTime type: string _links: $ref: '#/components/schemas/certificate__links' required: - _type - acme - certificate_arn - certificate_body - certificate_chain - common_name - created_at - id - issuer_common_name - issuer_country - issuer_organization - issuer_website - leaf_certificate - not_after - not_before - private_key_algorithm - self_signed - sha256_fingerprint - subject_alternative_names - subject_country - subject_locale - subject_organization - subject_state - trusted - updated_at code_scan_result: properties: id: type: integer dockerfile_present: type: boolean procfile_present: type: boolean aptible_yml_present: type: boolean _type: type: string created_at: format: dateTime type: string updated_at: format: dateTime type: string _links: $ref: '#/components/schemas/code_scan_result__links' required: - _type - aptible_yml_present - created_at - dockerfile_present - id - procfile_present - updated_at configuration: properties: id: type: integer _type: type: string env: type: object _links: $ref: '#/components/schemas/configuration__links' required: - _type - id container: properties: id: type: integer host: type: string port: type: integer status: type: string docker_name: type: string x-nullable: true _type: type: string created_at: format: dateTime type: string updated_at: format: dateTime type: string layer: type: string aws_instance_id: type: string x-nullable: true instance_class: type: string x-nullable: true memory_limit: type: integer port_mapping: items: items: type: integer type: array type: array allocation: items: type: string type: array mounts: items: items: type: string type: array type: array _links: $ref: '#/components/schemas/container__links' required: - _type - allocation - aws_instance_id - created_at - docker_name - host - id - instance_class - layer - memory_limit - mounts - port - port_mapping - status - updated_at database_credential: properties: id: type: integer _type: type: string created_at: format: dateTime type: string updated_at: format: dateTime type: string connection_url: type: string type: type: string default: type: boolean _links: $ref: '#/components/schemas/database_credential__links' required: - _type - created_at - default - id - type - updated_at database_image: properties: id: type: integer _type: type: string created_at: format: dateTime type: string updated_at: format: dateTime type: string type: type: string version: type: string discoverable: type: boolean visible: type: boolean default: type: boolean description: type: string docker_repo: type: string _links: $ref: '#/components/schemas/database_image__links' required: - _type - created_at - default - description - discoverable - docker_repo - id - type - updated_at - version - visible database: properties: id: type: integer handle: type: string type: type: string x-nullable: true passphrase: type: string x-nullable: true connection_url: type: string x-nullable: true provisioned: type: boolean _type: type: string created_at: format: dateTime type: string updated_at: format: dateTime type: string status: type: string docker_repo: type: string x-nullable: true port_mapping: items: items: type: integer type: array type: array initial_disk_size: type: integer x-nullable: true initial_container_size: type: integer x-nullable: true current_kms_arn: type: string x-nullable: true enable_backups: type: boolean pitr_bucket: type: string x-nullable: true oldest_pitr_time: type: string x-nullable: true enable_pitr: type: boolean pitr_status: default: unsupported enum: - unsupported - supported - pending_restart - restricted type: string _embedded: $ref: '#/components/schemas/database__embedded' _links: $ref: '#/components/schemas/database__links' required: - _embedded - _type - created_at - current_kms_arn - docker_repo - enable_backups - enable_pitr - handle - id - initial_container_size - initial_disk_size - oldest_pitr_time - pitr_bucket - pitr_status - port_mapping - provisioned - status - type - updated_at deployment: properties: id: type: integer _type: type: string status: type: string operation_id: type: integer app_id: type: integer configuration_id: type: integer x-nullable: true image_id: type: integer x-nullable: true source_id: type: integer x-nullable: true setting_id: type: integer x-nullable: true docker_image: type: string x-nullable: true docker_repository_url: type: string x-nullable: true git_repository_url: type: string x-nullable: true git_ref: type: string x-nullable: true git_commit_sha: type: string x-nullable: true git_commit_timestamp: format: dateTime type: string x-nullable: true git_commit_url: type: string x-nullable: true git_commit_message: type: string x-nullable: true created_at: format: dateTime type: string updated_at: format: dateTime type: string deleted_at: format: dateTime type: string x-nullable: true _links: $ref: '#/components/schemas/deployment__links' required: - _type - app_id - configuration_id - created_at - deleted_at - docker_image - docker_repository_url - git_commit_message - git_commit_sha - git_commit_timestamp - git_commit_url - git_ref - git_repository_url - id - image_id - operation_id - setting_id - source_id - status - updated_at disk_attachment: properties: id: type: integer _type: type: string mount_point: type: string status: type: string created_at: format: dateTime type: string updated_at: format: dateTime type: string deleted_at: format: dateTime type: string x-nullable: true _embedded: $ref: '#/components/schemas/disk_attachment__embedded' _links: $ref: '#/components/schemas/disk_attachment__links' required: - _embedded - _type - created_at - deleted_at - id - mount_point - status - updated_at disk: properties: id: type: integer handle: type: string ebs_volume_id: type: string x-nullable: true ebs_volume_type: type: string x-nullable: true filesystem: type: string passphrase: type: string key_bytes: type: integer size: type: integer provisioned_iops: type: integer host: type: string x-nullable: true device: type: string x-nullable: true attached: type: boolean _type: type: string created_at: format: dateTime type: string updated_at: format: dateTime type: string ec2_instance_id: type: string x-nullable: true baseline_iops: type: integer x-nullable: true availability_zone: type: string x-nullable: true current_kms_arn: type: string x-nullable: true _links: $ref: '#/components/schemas/disk__links' required: - _type - attached - availability_zone - baseline_iops - created_at - current_kms_arn - device - ebs_volume_id - ebs_volume_type - ec2_instance_id - filesystem - handle - host - id - key_bytes - provisioned_iops - size - updated_at ephemeral_container: properties: id: type: integer layer: type: string docker_name: type: string interactive: type: boolean memory_limit: type: integer allocation: items: type: string type: array created_at: format: dateTime type: string updated_at: format: dateTime type: string _type: type: string _links: $ref: '#/components/schemas/ephemeral_container__links' required: - _type - allocation - created_at - docker_name - id - interactive - layer - memory_limit - updated_at ephemeral_session: properties: id: type: integer aws_instance_id: type: string host: type: string name: type: string created_at: format: dateTime type: string updated_at: format: dateTime type: string _type: type: string _links: $ref: '#/components/schemas/ephemeral_session__links' required: - _type - aws_instance_id - created_at - host - id - name - updated_at image: properties: id: type: integer git_repo: type: string x-nullable: true git_ref: type: string x-nullable: true docker_repo: type: string x-nullable: true docker_ref: type: string x-nullable: true dualstack_hint: type: integer x-nullable: true platform: type: string x-nullable: true release: type: string x-nullable: true scan: type: string x-nullable: true exposed_ports: items: type: integer type: array _type: type: string created_at: format: dateTime type: string updated_at: format: dateTime type: string _links: $ref: '#/components/schemas/image__links' required: - _type - created_at - docker_ref - docker_repo - dualstack_hint - exposed_ports - git_ref - git_repo - id - platform - release - scan - updated_at intrusion_detection_report: properties: id: type: integer _type: type: string created_at: format: dateTime type: string updated_at: format: dateTime type: string starts_at: format: dateTime type: string ends_at: format: dateTime type: string _links: $ref: '#/components/schemas/intrusion_detection_report__links' required: - _type - created_at - ends_at - id - starts_at - updated_at llm_gateway_configuration: properties: id: description: Database ID of the LLM Gateway Configuration type: integer _type: type: string organization_id: description: The organization this configuration belongs to type: string team_id: description: The LiteLLM team ID for this organization type: string trial: description: Whether the organization is on a trial AI Gateway plan type: boolean spend_limit: description: "Monthly spend limit in USD (decimal, serialized as string)" type: string models: description: List of permitted model identifiers items: type: string type: array created_at: format: dateTime type: string x-nullable: true updated_at: format: dateTime type: string x-nullable: true _links: $ref: '#/components/schemas/llm_gateway_configuration__links' required: - _type - created_at - id - models - organization_id - spend_limit - team_id - trial - updated_at llm_gateway_key: properties: id: description: Database ID of the LLM Gateway Key type: integer _type: type: string handle: description: User-provided handle for the key (unique within the organization) type: string note: description: User-provided note type: string x-nullable: true spend_limit: description: "Spend limit in USD for this key (decimal, serialized as string).\ \ Null means the key has no limit of its own. Never exceeds the organization's\ \ spend_limit: lowering that lowers any key that was above it." type: string x-nullable: true organization_id: description: The organization this key belongs to type: string created_at: format: dateTime type: string x-nullable: true updated_at: format: dateTime type: string x-nullable: true gateway_url: description: Customer-facing LLM Gateway endpoint URL type: string x-nullable: true token_prefix: description: "The first characters of the key's token, safe to display and\ \ enough to tell keys apart" type: string x-nullable: true created_by: description: User who created the key type: object x-nullable: true revoked_at: description: Timestamp when the key was revoked format: dateTime type: string x-nullable: true revoked_by: description: User who revoked the key type: object x-nullable: true status: description: Key status (ACTIVE or REVOKED) type: string token: description: Secret API key value (only present on creation) type: string x-nullable: true _links: $ref: '#/components/schemas/llm_gateway_key__links' required: - _type - created_at - created_by - gateway_url - handle - id - note - organization_id - revoked_at - revoked_by - spend_limit - status - token_prefix - updated_at llm_key: properties: id: description: Database ID of the LLM Key type: integer _type: type: string handle: description: User-provided handle for the token (unique within account) type: string note: description: User-provided note (URL-safe base64 encoded) type: string x-nullable: true created_at: format: dateTime type: string x-nullable: true updated_at: format: dateTime type: string x-nullable: true gateway_url: description: Customer-facing LLM Gateway endpoint URL type: string x-nullable: true created_by: description: User who created the token type: object x-nullable: true revoked_at: description: Timestamp when token was revoked format: dateTime type: string x-nullable: true revoked_by: description: User who revoked the token type: object x-nullable: true status: description: Token status (ACTIVE or REVOKED) type: string token: description: Secret API key value (only present on creation) type: string x-nullable: true current_usage: $ref: '#/components/schemas/llm_key_current_usage' _links: $ref: '#/components/schemas/backup_retention_policy__links' required: - _type - created_at - created_by - gateway_url - handle - id - note - revoked_at - revoked_by - status - updated_at llm_policy: properties: id: description: Database ID of the LLM Policy type: integer _type: type: string spend_limit: description: Monthly spend limit in USD cents (nil means unlimited) type: integer x-nullable: true models: description: List of allowed model identifiers items: type: string type: array created_at: format: dateTime type: string x-nullable: true updated_at: format: dateTime type: string x-nullable: true current_usage: $ref: '#/components/schemas/llm_policy_current_usage' _links: $ref: '#/components/schemas/backup_retention_policy__links' required: - _type - created_at - id - models - spend_limit - updated_at log_drain: properties: id: type: integer _type: type: string handle: type: string drain_type: type: string drain_host: type: string drain_port: type: integer created_at: format: dateTime type: string updated_at: format: dateTime type: string status: type: string drain_username: type: string x-nullable: true drain_password: type: string x-nullable: true drain_apps: type: boolean drain_databases: type: boolean drain_ephemeral_sessions: type: boolean drain_proxies: type: boolean gentlemanjerry_certificate: type: string x-nullable: true gentlemanjerry_docker_name: type: string x-nullable: true gentlemanjerry_instance_id: type: string x-nullable: true gentlemanjerry_host: type: string x-nullable: true gentlemanjerry_port_mapping: items: items: type: integer type: array type: array gentlemanjerry_allocation: items: type: string type: array url: type: string x-nullable: true logging_token: type: string x-nullable: true _links: $ref: '#/components/schemas/log_drain__links' required: - _type - created_at - drain_apps - drain_databases - drain_ephemeral_sessions - drain_host - drain_port - drain_proxies - drain_type - gentlemanjerry_allocation - gentlemanjerry_certificate - gentlemanjerry_docker_name - gentlemanjerry_host - gentlemanjerry_instance_id - gentlemanjerry_port_mapping - handle - id - status - updated_at maintenance_window: properties: id: type: integer account_id: type: integer day_of_week: type: integer x-nullable: true start_time_utc: description: "Start of the window, in UTC, as HH:MM (e.g. \"22:00\")" type: string duration_hours: type: integer enabled: type: boolean created_at: format: dateTime type: string updated_at: format: dateTime type: string _links: $ref: '#/components/schemas/maintenance_window__links' required: - id metric_drain: properties: id: type: integer _type: type: string handle: type: string created_at: format: dateTime type: string updated_at: format: dateTime type: string status: type: string drain_type: type: string unified: type: boolean drain_configuration: $ref: '#/components/schemas/metric_drain_drain_configuration' aggregator_ca_certificate: type: string x-nullable: true aggregator_ca_private_key_blob: type: string x-nullable: true aggregator_host: type: string x-nullable: true aggregator_port_mapping: items: items: type: integer type: array type: array aggregator_instance_id: type: string x-nullable: true aggregator_docker_name: type: string x-nullable: true aggregator_allocation: items: type: string type: array _links: $ref: '#/components/schemas/metric_drain__links' required: - _type - aggregator_allocation - aggregator_ca_certificate - aggregator_ca_private_key_blob - aggregator_docker_name - aggregator_host - aggregator_instance_id - aggregator_port_mapping - created_at - drain_type - handle - id - status - updated_at operation: properties: id: type: integer _type: type: string type: type: string status: type: string cancelled: type: boolean aborted: type: boolean git_ref: type: string x-nullable: true docker_ref: type: string x-nullable: true deploy_image_id: type: integer x-nullable: true env: type: object x-nullable: true container_size: type: integer x-nullable: true container_count: type: integer x-nullable: true disk_size: type: integer command: type: string x-nullable: true handle: type: string x-nullable: true created_at: format: dateTime type: string updated_at: format: dateTime type: string certificate: type: string x-nullable: true private_key: type: string x-nullable: true user_name: type: string user_email: type: string destination_region: type: string x-nullable: true interactive: type: boolean x-nullable: true instance_profile: type: string x-nullable: true mount_point: type: string x-nullable: true daily: type: integer x-nullable: true monthly: type: integer x-nullable: true yearly: type: integer x-nullable: true pitr_days: type: integer x-nullable: true make_copy: type: boolean x-nullable: true keep_final: type: boolean x-nullable: true enable_backups: type: boolean x-nullable: true enable_pitr: type: boolean x-nullable: true settings: type: object sensitive_settings: type: object _links: $ref: '#/components/schemas/operation__links' required: - _type - aborted - cancelled - certificate - command - container_count - container_size - created_at - daily - destination_region - disk_size - docker_ref - enable_backups - enable_pitr - git_ref - handle - id - instance_profile - interactive - keep_final - make_copy - monthly - mount_point - pitr_days - settings - status - type - updated_at - user_email - user_name - yearly permission: properties: id: type: integer _type: type: string scope: type: string _links: $ref: '#/components/schemas/permission__links' required: - _type - id - scope persistent_disk: properties: _type: type: string id: type: integer handle: type: string status: type: string disk_type: type: string size: type: integer provisioned_iops: type: integer disk_status: type: string x-nullable: true aws_resource_id: type: string x-nullable: true kms_arn: type: string x-nullable: true modification_progress: type: integer x-nullable: true availability_zone: type: string x-nullable: true formatted: type: boolean created_at: format: dateTime type: string updated_at: format: dateTime type: string modified_at: format: dateTime type: string x-nullable: true deleted_at: format: dateTime type: string x-nullable: true _links: $ref: '#/components/schemas/persistent_disk__links' required: - _type - availability_zone - aws_resource_id - created_at - deleted_at - disk_status - disk_type - formatted - handle - id - kms_arn - modification_progress - modified_at - provisioned_iops - size - status - updated_at plan: properties: id: type: integer _type: type: string container_memory_limit_mb: type: integer cpu_allowed_profiles: items: type: string type: array disk_limit_gb: type: integer ephemeral_session_limit: type: integer environment_limit: type: integer vhost_limit: type: integer cost_cents: type: integer included_container_mb: type: integer included_disk_gb: type: integer included_vhosts: type: integer compliance_dashboard_access: type: boolean created_at: format: dateTime type: string updated_at: format: dateTime type: string _links: $ref: '#/components/schemas/llm_gateway_configuration__links' required: - _type - compliance_dashboard_access - container_memory_limit_mb - cost_cents - cpu_allowed_profiles - created_at - disk_limit_gb - environment_limit - ephemeral_session_limit - id - included_container_mb - included_disk_gb - included_vhosts - updated_at - vhost_limit prerelease_command: properties: id: type: integer _type: type: string command: type: string index: type: integer created_at: format: dateTime type: string updated_at: format: dateTime type: string _links: $ref: '#/components/schemas/prerelease_command__links' required: - _type - command - created_at - id - index - updated_at release: properties: id: type: integer _type: type: string docker_repo: type: string x-nullable: true docker_ref: type: string x-nullable: true created_at: format: dateTime type: string updated_at: format: dateTime type: string _links: $ref: '#/components/schemas/release__links' required: - _type - created_at - docker_ref - docker_repo - id - updated_at service_definition: properties: id: type: integer _type: type: string command: type: string process_type: type: string created_at: format: dateTime type: string updated_at: format: dateTime type: string _links: $ref: '#/components/schemas/prerelease_command__links' required: - _type - command - created_at - id - process_type - updated_at service_sizing_policy: properties: id: type: integer _type: type: string created_at: type: string updated_at: type: string scaling_enabled: type: boolean default_policy: type: boolean metric_lookback_seconds: type: integer percentile: type: number post_scale_up_cooldown_seconds: type: integer post_scale_down_cooldown_seconds: type: integer post_release_cooldown_seconds: type: integer mem_cpu_ratio_r_threshold: type: number mem_cpu_ratio_c_threshold: type: number mem_scale_up_threshold: type: number mem_scale_down_threshold: type: number minimum_memory: type: integer account_id: type: integer x-nullable: true maximum_memory: type: integer x-nullable: true autoscaling: type: string min_cpu_threshold: type: number x-nullable: true max_cpu_threshold: type: number x-nullable: true min_containers: type: integer x-nullable: true max_containers: type: integer x-nullable: true scale_up_step: type: integer x-nullable: true scale_down_step: type: integer x-nullable: true use_horizontal_scale: type: boolean service_id: type: integer x-nullable: true _links: $ref: '#/components/schemas/backup_retention_policy__links' required: - _type - account_id - autoscaling - created_at - default_policy - id - max_containers - max_cpu_threshold - maximum_memory - mem_cpu_ratio_c_threshold - mem_cpu_ratio_r_threshold - mem_scale_down_threshold - mem_scale_up_threshold - metric_lookback_seconds - min_containers - min_cpu_threshold - minimum_memory - percentile - post_release_cooldown_seconds - post_scale_down_cooldown_seconds - post_scale_up_cooldown_seconds - scale_down_step - scale_up_step - scaling_enabled - updated_at - use_horizontal_scale service: properties: id: type: integer _type: type: string handle: type: string docker_repo: type: string x-nullable: true docker_ref: type: string x-nullable: true process_type: type: string command: type: string container_count: type: integer created_at: format: dateTime type: string updated_at: format: dateTime type: string container_memory_limit_mb: type: integer x-nullable: true instance_class: type: string force_zero_downtime: type: boolean naive_health_check: type: boolean restart_free_scaling: type: boolean stop_timeout: type: integer x-nullable: true _links: $ref: '#/components/schemas/service__links' required: - _type - command - container_count - container_memory_limit_mb - created_at - docker_ref - docker_repo - force_zero_downtime - handle - id - instance_class - naive_health_check - process_type - restart_free_scaling - stop_timeout - updated_at setting: properties: id: type: integer _type: type: string settings: type: object sensitive_settings: type: object _links: $ref: '#/components/schemas/configuration__links' required: - _type - id - settings source: properties: id: type: integer _type: type: string qualified_name: type: string display_name: type: string url: type: string _links: $ref: '#/components/schemas/source__links' required: - _type - display_name - id - qualified_name - url ssh_portal_connection: properties: id: format: uuid type: string _type: type: string ssh_user: type: string ssh_certificate_body: type: string ssh_port_forward_socket: type: string x-nullable: true ssh_pty: type: boolean created_at: format: dateTime type: string updated_at: format: dateTime type: string _links: $ref: '#/components/schemas/ssh_portal_connection__links' required: - _type - created_at - id - ssh_certificate_body - ssh_port_forward_socket - ssh_pty - ssh_user - updated_at stack: properties: id: type: integer _type: type: string name: type: string version: enum: - v1 - v2 type: string region: type: string default: type: boolean x-nullable: true public: type: boolean created_at: format: dateTime type: string updated_at: format: dateTime type: string ssh_host_dsa_public_key: type: string ssh_host_rsa_public_key: type: string ssh_host_ecdsa_public_key: type: string ssh_portal_host: type: string ssh_portal_port: type: integer outbound_ip_addresses: items: type: string type: array memory_limits: type: boolean cpu_limits: type: boolean intrusion_detection: type: boolean expose_intrusion_detection_reports: type: boolean account_id: type: string x-nullable: true vpc_id: type: string x-nullable: true internal_domain: type: string x-nullable: true default_domain: type: string x-nullable: true brickwall_enabled: type: boolean vpc_cidr: type: string x-nullable: true _links: $ref: '#/components/schemas/stack__links' required: - _type - account_id - brickwall_enabled - cpu_limits - created_at - default - default_domain - expose_intrusion_detection_reports - id - internal_domain - intrusion_detection - memory_limits - name - outbound_ip_addresses - public - region - ssh_host_dsa_public_key - ssh_host_ecdsa_public_key - ssh_host_rsa_public_key - ssh_portal_host - ssh_portal_port - updated_at - version - vpc_cidr - vpc_id vhost: properties: id: type: integer _type: type: string virtual_domain: type: string type: enum: - http - http_proxy_protocol - tcp - tls - grpc type: string elastic_load_balancer_name: type: string x-nullable: true application_load_balancer_arn: type: string x-nullable: true network_load_balancer_arn: type: string x-nullable: true security_group_id: type: string x-nullable: true external_host: type: string x-nullable: true external_http_port: type: integer x-nullable: true external_https_port: type: integer x-nullable: true internal_host: type: string x-nullable: true internal_http_port: type: integer x-nullable: true internal_https_port: type: integer x-nullable: true internal_health_port: type: integer x-nullable: true docker_name: type: string x-nullable: true created_at: format: dateTime type: string updated_at: format: dateTime type: string status: type: string platform: enum: - alb - elb - nlb type: string default: type: boolean internal: type: boolean container_exposed_ports: items: type: integer type: array x-nullable: true host_mapped_ports: items: type: integer type: array x-nullable: true ip_whitelist: items: type: string type: array user_domain: type: string x-nullable: true acme: type: boolean acme_status: type: string x-nullable: true acme_dns_challenge_host: type: string x-nullable: true container_port: type: integer x-nullable: true container_ports: items: type: integer type: array acme_configuration: $ref: '#/components/schemas/vhost_acme_configuration' shared: type: boolean x-nullable: true shared_fingerprint: type: string x-nullable: true load_balancing_algorithm_type: type: string x-nullable: true _links: $ref: '#/components/schemas/vhost__links' required: - _type - acme - acme_configuration - acme_dns_challenge_host - acme_status - application_load_balancer_arn - container_exposed_ports - container_port - container_ports - created_at - default - docker_name - elastic_load_balancer_name - external_host - external_http_port - external_https_port - host_mapped_ports - id - internal - internal_health_port - internal_host - internal_http_port - internal_https_port - ip_whitelist - load_balancing_algorithm_type - network_load_balancer_arn - platform - security_group_id - shared - shared_fingerprint - status - type - updated_at - user_domain - virtual_domain vpc_peer: properties: id: type: integer _type: type: string created_at: format: dateTime type: string updated_at: format: dateTime type: string connection_id: type: string connection_status: type: string peer_account_id: type: string peer_vpc_id: type: string description: type: string _links: $ref: '#/components/schemas/vpc_peer__links' required: - _type - connection_id - connection_status - created_at - description - id - peer_account_id - peer_vpc_id - updated_at vpn_tunnel: properties: id: type: integer _type: type: string created_at: format: dateTime type: string updated_at: format: dateTime type: string handle: type: string phase_1_alg: type: string x-nullable: true phase_1_dh_group: type: integer x-nullable: true phase_1_lifetime: type: integer x-nullable: true phase_2_alg: type: string x-nullable: true phase_2_dh_group: type: integer x-nullable: true phase_2_lifetime: type: integer x-nullable: true perfect_forward_secrecy: type: boolean x-nullable: true our_gateway: type: string x-nullable: true our_networks: items: items: type: string type: array type: array x-nullable: true peer_gateway: type: string x-nullable: true peer_networks: items: items: type: string type: array type: array x-nullable: true _links: $ref: '#/components/schemas/vpc_peer__links' required: - _type - created_at - handle - id - our_gateway - our_networks - peer_gateway - peer_networks - perfect_forward_secrecy - phase_1_alg - phase_1_dh_group - phase_1_lifetime - phase_2_alg - phase_2_dh_group - phase_2_lifetime - updated_at error: properties: code: type: integer error: type: string message: type: string required: - code - error - message type: object ListAccountsForStack_200_response__embedded: properties: accounts: items: $ref: '#/components/schemas/account' type: array type: object ListAccountsForStack_200_response__links_stack: properties: href: format: uri type: string type: object ListAccountsForStack_200_response__links: properties: stack: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' next: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' prev: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object ListAccountsForStack_200_response: properties: _embedded: $ref: '#/components/schemas/ListAccountsForStack_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: $ref: '#/components/schemas/ListAccountsForStack_200_response__links' required: - _embedded - _links - current_page - per_page - total_count type: object CreateAccount_request: properties: type: type: string handle: type: string organization_id: type: string name: type: string stack_id: type: integer required: - handle - organization_id - type type: object UpdateAccount_request: properties: handle: type: string name: type: string onboarding_status: type: string type: object PatchAccount_request: properties: handle: type: string name: type: string type: object ListActivityReportsForAccount_200_response__embedded: properties: activity_reports: items: $ref: '#/components/schemas/activity_report' type: array type: object ListActivityReportsForAccount_200_response__links: properties: account: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' next: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' prev: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object ListActivityReportsForAccount_200_response: properties: _embedded: $ref: '#/components/schemas/ListActivityReportsForAccount_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: $ref: '#/components/schemas/ListActivityReportsForAccount_200_response__links' required: - _embedded - _links - current_page - per_page - total_count type: object ListAppsForAccount_200_response__embedded: properties: apps: items: $ref: '#/components/schemas/app' type: array type: object ListAppsForAccount_200_response: properties: _embedded: $ref: '#/components/schemas/ListAppsForAccount_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: $ref: '#/components/schemas/ListActivityReportsForAccount_200_response__links' required: - _embedded - _links - current_page - per_page - total_count type: object CreateApp_request: properties: handle: type: string required: - handle type: object UpdateApp_request: properties: current_configuration: format: uri type: string current_image: format: uri type: string handle: type: string status: type: string type: object ListBackupRetentionPoliciesForAccount_200_response__embedded: properties: backup_retention_policies: items: $ref: '#/components/schemas/backup_retention_policy' type: array type: object ListBackupRetentionPoliciesForAccount_200_response: properties: _embedded: $ref: '#/components/schemas/ListBackupRetentionPoliciesForAccount_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: $ref: '#/components/schemas/ListActivityReportsForAccount_200_response__links' required: - _embedded - _links - current_page - per_page - total_count type: object CreateBackupRetentionPolicy_request: properties: daily: type: integer x-omitempty: false monthly: type: integer x-omitempty: false yearly: type: integer x-omitempty: false keep_final: type: boolean x-omitempty: false make_copy: type: boolean x-omitempty: false type: object ListBackups_200_response__embedded: properties: backups: items: $ref: '#/components/schemas/backup' type: array type: object ListBackups_200_response__links: properties: account: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' database: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' next: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' prev: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object ListBackups_200_response: properties: _embedded: $ref: '#/components/schemas/ListBackups_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: $ref: '#/components/schemas/ListBackups_200_response__links' required: - _embedded - _links - current_page - per_page - total_count type: object ListCertificatesForAccount_200_response__embedded: properties: certificates: items: $ref: '#/components/schemas/certificate' type: array type: object ListCertificatesForAccount_200_response: properties: _embedded: $ref: '#/components/schemas/ListCertificatesForAccount_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: $ref: '#/components/schemas/ListActivityReportsForAccount_200_response__links' required: - _embedded - _links - current_page - per_page - total_count type: object CreateCertificate_request: properties: certificate_body: type: string private_key: type: string required: - certificate_body - private_key type: object PatchCertificate_request: properties: certificate_arn: type: string type: object CreateClaim_request: properties: type: enum: - app - database - account type: string handle: type: string required: - type type: object CreateClaimForType_request: properties: handle: type: string type: object ListCodeScanResultsForApp_200_response__embedded: properties: code_scan_results: items: $ref: '#/components/schemas/code_scan_result' type: array type: object ListCodeScanResultsForApp_200_response__links: properties: resource: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' next: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' prev: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object ListCodeScanResultsForApp_200_response: properties: _embedded: $ref: '#/components/schemas/ListCodeScanResultsForApp_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: $ref: '#/components/schemas/ListCodeScanResultsForApp_200_response__links' required: - _embedded - _links - current_page - per_page - total_count type: object CreateCodeScanResult_request: properties: operation: description: Alternate name for `operation_id` type: integer operation_id: type: integer dockerfile_present: type: boolean procfile_present: type: boolean aptible_yml_present: type: boolean git_ref: type: string git_commit: type: string required: - git_commit - git_ref - operation_id type: object ListConfigurationsForApp_200_response__embedded: properties: configurations: items: $ref: '#/components/schemas/configuration' type: array type: object ListConfigurationsForApp_200_response: properties: _embedded: $ref: '#/components/schemas/ListConfigurationsForApp_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: $ref: '#/components/schemas/ListCodeScanResultsForApp_200_response__links' required: - _embedded - _links - current_page - per_page - total_count type: object CreateConfigurationForApp_request: properties: env: description: Mapping of environment variables type: object required: - env type: object ListContainersForRelease_200_response__embedded: properties: containers: items: $ref: '#/components/schemas/container' type: array type: object ListContainersForRelease_200_response__links: properties: release: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' log_drain: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' next: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' prev: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object ListContainersForRelease_200_response: properties: _embedded: $ref: '#/components/schemas/ListContainersForRelease_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: $ref: '#/components/schemas/ListContainersForRelease_200_response__links' required: - _embedded - _links - current_page - per_page - total_count type: object ListDatabaseCredentialsForDatabase_200_response__embedded: properties: database_credentials: items: $ref: '#/components/schemas/database_credential' type: array type: object ListDatabaseCredentialsForDatabase_200_response__links: properties: database: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' next: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' prev: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object ListDatabaseCredentialsForDatabase_200_response: properties: _embedded: $ref: '#/components/schemas/ListDatabaseCredentialsForDatabase_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: $ref: '#/components/schemas/ListDatabaseCredentialsForDatabase_200_response__links' required: - _embedded - _links - current_page - per_page - total_count type: object ListDatabaseImages_200_response__embedded: properties: database_images: items: $ref: '#/components/schemas/database_image' type: array type: object ListDatabaseImages_200_response__links: properties: next: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' prev: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object ListDatabaseImages_200_response: properties: _embedded: $ref: '#/components/schemas/ListDatabaseImages_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: $ref: '#/components/schemas/ListDatabaseImages_200_response__links' required: - _embedded - _links - current_page - per_page - total_count type: object ListDatabasesForAccount_200_response__embedded: properties: databases: items: $ref: '#/components/schemas/database' type: array type: object ListDatabasesForAccount_200_response: properties: _embedded: $ref: '#/components/schemas/ListDatabasesForAccount_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: $ref: '#/components/schemas/ListActivityReportsForAccount_200_response__links' required: - _embedded - _links - current_page - per_page - total_count type: object CreateDatabase_request: properties: handle: type: string type: type: string initial_disk_size: type: integer initial_container_size: type: integer initialize_from: type: string database_image: description: Alternate name for `database_image_id` type: integer database_image_id: type: integer current_kms_arn: type: string enable_backups: type: boolean enable_pitr: type: boolean required: - handle - type type: object UpdateDatabase_request: properties: current_configuration: type: integer handle: type: string initial_disk_size: type: integer initial_continer_size: type: integer database_image_id: type: integer current_kms_arn: type: string enable_backups: type: boolean type: object ListDeployments_200_response__embedded: properties: deployments: items: $ref: '#/components/schemas/deployment' type: array type: object ListDeployments_200_response__links: properties: parent: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' next: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' prev: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object ListDeployments_200_response: properties: _embedded: $ref: '#/components/schemas/ListDeployments_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: $ref: '#/components/schemas/ListDeployments_200_response__links' required: - _embedded - _links - current_page - per_page - total_count type: object ListDiskAttachmentsForAccount_200_response__embedded: properties: disk_attachments: items: $ref: '#/components/schemas/disk_attachment' type: array type: object ListDiskAttachmentsForAccount_200_response: properties: _embedded: $ref: '#/components/schemas/ListDiskAttachmentsForAccount_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: $ref: '#/components/schemas/ListActivityReportsForAccount_200_response__links' required: - _embedded - _links - current_page - per_page - total_count type: object ListDiskAttachmentsForService_200_response__links: properties: service: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' next: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' prev: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object ListDiskAttachmentsForService_200_response: properties: _embedded: $ref: '#/components/schemas/ListDiskAttachmentsForAccount_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: $ref: '#/components/schemas/ListDiskAttachmentsForService_200_response__links' required: - _embedded - _links - current_page - per_page - total_count type: object ListDiskAttachmentsForPersistentDisk_200_response__links: properties: persistent_disk: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' next: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' prev: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object ListDiskAttachmentsForPersistentDisk_200_response: properties: _embedded: $ref: '#/components/schemas/ListDiskAttachmentsForAccount_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: $ref: '#/components/schemas/ListDiskAttachmentsForPersistentDisk_200_response__links' required: - _embedded - _links - current_page - per_page - total_count type: object ListDiskAttachments_200_response: properties: _embedded: $ref: '#/components/schemas/ListDiskAttachmentsForAccount_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: $ref: '#/components/schemas/ListDatabaseImages_200_response__links' required: - _embedded - _links - current_page - per_page - total_count type: object ListDisksForAccount_200_response__embedded: properties: disks: items: $ref: '#/components/schemas/disk' type: array type: object ListDisksForAccount_200_response: properties: _embedded: $ref: '#/components/schemas/ListDisksForAccount_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: $ref: '#/components/schemas/ListActivityReportsForAccount_200_response__links' required: - _embedded - _links - current_page - per_page - total_count type: object ListEphemeralContainersForEphemeralSession_200_response__embedded: properties: ephemeral_containers: items: $ref: '#/components/schemas/ephemeral_container' type: array type: object ListEphemeralContainersForEphemeralSession_200_response__links: properties: ephemeral_session: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' log_drain: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' next: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' prev: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object ListEphemeralContainersForEphemeralSession_200_response: properties: _embedded: $ref: '#/components/schemas/ListEphemeralContainersForEphemeralSession_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: $ref: '#/components/schemas/ListEphemeralContainersForEphemeralSession_200_response__links' required: - _embedded - _links - current_page - per_page - total_count type: object ListEphemeralSessionsForApp_200_response__embedded: properties: ephemeral_sessions: items: $ref: '#/components/schemas/ephemeral_session' type: array type: object ListEphemeralSessionsForApp_200_response__links: properties: app: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' operation: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' next: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' prev: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object ListEphemeralSessionsForApp_200_response: properties: _embedded: $ref: '#/components/schemas/ListEphemeralSessionsForApp_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: $ref: '#/components/schemas/ListEphemeralSessionsForApp_200_response__links' required: - _embedded - _links - current_page - per_page - total_count type: object GetRoot_200_response__links: properties: accounts: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' apps: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' databases: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' database_images: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' stacks: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object GetRoot_200_response: properties: _links: $ref: '#/components/schemas/GetRoot_200_response__links' required: - _links type: object ListImagesForApp_200_response__embedded: properties: images: items: $ref: '#/components/schemas/image' type: array type: object ListImagesForApp_200_response__links: properties: app: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' next: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' prev: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object ListImagesForApp_200_response: properties: _embedded: $ref: '#/components/schemas/ListImagesForApp_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: $ref: '#/components/schemas/ListImagesForApp_200_response__links' required: - _embedded - _links - current_page - per_page - total_count type: object ListIntrustionDetectionReportsForStack_200_response__embedded: properties: intrusion_detection_reports: items: $ref: '#/components/schemas/intrusion_detection_report' type: array type: object ListIntrustionDetectionReportsForStack_200_response: properties: _embedded: $ref: '#/components/schemas/ListIntrustionDetectionReportsForStack_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: $ref: '#/components/schemas/ListAccountsForStack_200_response__links' required: - _embedded - _links - current_page - per_page - total_count type: object ListLlmGatewayConfigurations_200_response__embedded: properties: llm_gateway_configurations: items: $ref: '#/components/schemas/llm_gateway_configuration' type: array type: object ListLlmGatewayConfigurations_200_response: properties: _embedded: $ref: '#/components/schemas/ListLlmGatewayConfigurations_200_response__embedded' _links: type: object type: object CreateLlmGatewayConfiguration_request: properties: organization_id: description: The organization to enroll type: string required: - organization_id type: object UpdateLlmGatewayConfiguration_request: properties: spend_limit: description: "New monthly spend limit in USD. Lowering it also lowers the\ \ spend_limit of any of the organization's keys that are above the new\ \ limit, to match." type: number models: description: List of permitted model identifiers items: type: string type: array type: object ListLlmGatewayKeys_200_response__embedded: properties: llm_gateway_keys: items: $ref: '#/components/schemas/llm_gateway_key' type: array type: object ListLlmGatewayKeys_200_response: properties: _embedded: $ref: '#/components/schemas/ListLlmGatewayKeys_200_response__embedded' _links: type: object total_count: type: integer per_page: type: integer current_page: type: integer type: object CreateLlmGatewayKey_request: properties: handle: description: "Handle for the key, unique within the organization" type: string note: description: "Note about the key, up to 256 characters" type: string spend_limit: description: "Spend limit in USD for this key. Must not exceed the organization's\ \ spend_limit. Omit it, or send null, for a key with no limit of its own." type: number x-nullable: true organization_id: description: "The organization to create the key in. Required unless the\ \ caller belongs to exactly one organization, in which case it is inferred\ \ from the token." type: string required: - handle type: object UpdateLlmGatewayKey_request: minProperties: 1 properties: handle: description: "New handle for the key, unique within the organization" type: string spend_limit: description: "New spend limit in USD for this key, or null to remove it.\ \ Must not exceed the organization's spend_limit." type: number x-nullable: true type: object ListLlmKeysForAccount_200_response__embedded: properties: llm_keys: items: $ref: '#/components/schemas/llm_key' type: array type: object ListLlmKeysForAccount_200_response: properties: _embedded: $ref: '#/components/schemas/ListLlmKeysForAccount_200_response__embedded' _links: type: object type: object ListLlmKeys_200_response: properties: _embedded: $ref: '#/components/schemas/ListLlmKeysForAccount_200_response__embedded' _links: type: object total_count: type: integer per_page: type: integer current_page: type: integer type: object GetLlmKeyUsage_200_response: properties: spend: description: Total spend in USD type: number input_tokens: description: Total input (prompt) tokens type: integer output_tokens: description: Total output (completion) tokens type: integer successful_requests: description: Total successful API requests type: integer failed_requests: description: Total failed API requests type: integer type: object GetLlmKeyRequests_200_response__embedded_requests_inner: properties: _id: type: string status: type: string start_time: type: string end_time: type: string model: type: string input_tokens: type: integer output_tokens: type: integer spend: type: number type: object GetLlmKeyRequests_200_response__embedded: properties: requests: items: $ref: '#/components/schemas/GetLlmKeyRequests_200_response__embedded_requests_inner' type: array type: object GetLlmKeyRequests_200_response__links_self: properties: href: type: string type: object GetLlmKeyRequests_200_response__links: properties: self: $ref: '#/components/schemas/GetLlmKeyRequests_200_response__links_self' next: $ref: '#/components/schemas/GetLlmKeyRequests_200_response__links_self' prev: $ref: '#/components/schemas/GetLlmKeyRequests_200_response__links_self' type: object GetLlmKeyRequests_200_response: properties: _embedded: $ref: '#/components/schemas/GetLlmKeyRequests_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: $ref: '#/components/schemas/GetLlmKeyRequests_200_response__links' type: object ListLlmPoliciesForAccount_200_response__embedded: properties: llm_policies: items: $ref: '#/components/schemas/llm_policy' type: array type: object ListLlmPoliciesForAccount_200_response: properties: _embedded: $ref: '#/components/schemas/ListLlmPoliciesForAccount_200_response__embedded' _links: type: object type: object ListLlmPolicies_200_response: properties: _embedded: $ref: '#/components/schemas/ListLlmPoliciesForAccount_200_response__embedded' _links: type: object total_count: type: integer per_page: type: integer current_page: type: integer type: object ListLogDrainsForAccount_200_response__embedded: properties: log_drains: items: $ref: '#/components/schemas/log_drain' type: array type: object ListLogDrainsForAccount_200_response: properties: _embedded: $ref: '#/components/schemas/ListLogDrainsForAccount_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: $ref: '#/components/schemas/ListActivityReportsForAccount_200_response__links' required: - _embedded - _links - current_page - per_page - total_count type: object CreateLogDrain_request: properties: handle: type: string drain_type: type: string drain_host: description: For syslog-tls-tcp drains format: uri type: string drain_port: description: For syslog-tls-tcp drains type: integer drain_username: description: "DEPRECATED: For legacy Elasticsearch drains" type: string drain_password: description: For Tail drains type: string database: description: For Deploy-hosted Elasticsearch drains format: uri type: string database_id: description: For Deploy-hosted Elasticsearch drains type: integer url: description: For HTTPs Post drains format: uri type: string logging_token: type: string drain_apps: type: boolean x-omitempty: false drain_databases: type: boolean x-omitempty: false drain_ephemeral_sessions: type: boolean x-omitempty: false drain_proxies: type: boolean x-omitempty: false required: - drain_type - handle type: object UpdateLogDrain_request: properties: drain_apps: type: boolean x-omitempty: false drain_databases: type: boolean x-omitempty: false drain_ephemeral_sessions: type: boolean x-omitempty: false drain_proxies: type: boolean x-omitempty: false type: object UpdateMaintenanceWindowForApp_request: properties: day_of_week: type: integer x-nullable: true x-omitempty: false start_time_utc: type: string x-omitempty: false duration_hours: type: integer x-omitempty: false enabled: type: boolean x-omitempty: false type: object CreateMaintenanceWindowForApp_request: properties: day_of_week: description: Day of week the window applies to (0 = Sunday .. 6 = Saturday). Omit to apply every day. type: integer x-nullable: true start_time_utc: description: "Start of the window, in UTC (e.g. \"22:00\")" type: string duration_hours: description: Length of the window in hours (2-24) type: integer enabled: type: boolean required: - duration_hours - start_time_utc type: object ListMetricDrainsForAccount_200_response__embedded: properties: metric_drains: items: $ref: '#/components/schemas/metric_drain' type: array type: object ListMetricDrainsForAccount_200_response: properties: _embedded: $ref: '#/components/schemas/ListMetricDrainsForAccount_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: $ref: '#/components/schemas/ListActivityReportsForAccount_200_response__links' required: - _embedded - _links - current_page - per_page - total_count type: object CreateMetricDrain_request_drain_configuration: description: For external metric drain hosts properties: address: format: uri type: string username: type: string password: type: string database: type: string api_key: type: string series_url: format: uri type: string authToken: type: string bucket: type: string org: type: string type: object CreateMetricDrain_request: properties: handle: type: string drain_type: type: string drain_configuration: $ref: '#/components/schemas/CreateMetricDrain_request_drain_configuration' database: description: For Deploy-hosted InfluxDB instances format: uri type: string database_id: description: For Deploy-hosted InfluxDB instances type: integer required: - drain_type - handle type: object GetMaintenanceApps_200_response__embedded_apps_inner: properties: id: type: integer handle: type: string _type: type: string created_at: type: string updated_at: type: string status: type: string maintenance_deadline: items: format: date-time type: string type: array x-nullable: true account_id: type: integer _links: type: object type: object GetMaintenanceApps_200_response__embedded: properties: apps: items: $ref: '#/components/schemas/GetMaintenanceApps_200_response__embedded_apps_inner' type: array type: object GetMaintenanceApps_200_response: properties: _embedded: $ref: '#/components/schemas/GetMaintenanceApps_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: type: object type: object GetMaintenanceDatabases_200_response__embedded_databases_inner: properties: id: type: integer handle: type: string type: type: string x-nullable: true provisioned: type: boolean _type: type: string created_at: type: string updated_at: type: string deleted_at: type: string x-nullable: true status: type: string maintenance_deadline: items: format: date-time type: string type: array x-nullable: true _links: type: object type: object GetMaintenanceDatabases_200_response__embedded: properties: databases: items: $ref: '#/components/schemas/GetMaintenanceDatabases_200_response__embedded_databases_inner' type: array type: object GetMaintenanceDatabases_200_response: properties: _embedded: $ref: '#/components/schemas/GetMaintenanceDatabases_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: type: object type: object ListOperationsForPersistentDisk_200_response__embedded: properties: operations: items: $ref: '#/components/schemas/operation' type: array type: object ListOperationsForPersistentDisk_200_response: properties: _embedded: $ref: '#/components/schemas/ListOperationsForPersistentDisk_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: $ref: '#/components/schemas/ListDatabaseImages_200_response__links' required: - _embedded - _links - current_page - per_page - total_count type: object CreateOperationRequest: example: container_size: 1 certificate: certificate interactive: true instance_profile: instance_profile type: type docker_ref: docker_ref container_count: 6 pitr_days: 2 keep_final: true deploy_image_id: 5 make_copy: true key_arn: key_arn destination_account: https://openapi-generator.tech settings: key: settings destination_account_id: 5 sensitive_settings: key: sensitive_settings enable_pitr: true destination_region: destination_region disk_size: 0 handle: handle private_key: private_key env: key: env command: command automated: true provisioned_iops: 2 daily: 7 enable_backups: true git_ref: git_ref monthly: 9 yearly: 3 properties: type: type: string git_ref: type: string disk_size: type: integer container_count: type: integer x-omitempty: false container_size: type: integer command: type: string env: additionalProperties: type: string type: object handle: type: string certificate: type: string private_key: type: string destination_region: type: string interactive: type: boolean x-omitempty: false destination_account: format: uri type: string destination_account_id: type: integer deploy_image_id: type: integer docker_ref: type: string automated: type: boolean x-omitempty: false key_arn: type: string instance_profile: type: string provisioned_iops: type: integer daily: type: integer monthly: type: integer yearly: type: integer pitr_days: type: integer make_copy: type: boolean x-omitempty: false keep_final: type: boolean x-omitempty: false enable_backups: type: boolean x-omitempty: false enable_pitr: type: boolean x-omitempty: false settings: additionalProperties: type: string description: Non-sensitive settings for the operation type: object sensitive_settings: additionalProperties: type: string description: Sensitive settings for the operation (encrypted) type: object required: - type title: CreateOperationRequest type: object UpdateOperation_request: properties: cancelled: type: boolean x-omitempty: false type: object ListPermissionsForAccount_200_response__embedded: properties: permissions: items: $ref: '#/components/schemas/permission' type: array type: object ListPermissionsForAccount_200_response: properties: _embedded: $ref: '#/components/schemas/ListPermissionsForAccount_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: $ref: '#/components/schemas/ListActivityReportsForAccount_200_response__links' required: - _embedded - _links - current_page - per_page - total_count type: object CreatePermission_request: properties: role: format: uuid type: string scope: enum: - read - admin - observability - deploy - sensitive - tunnel - destroy type: string required: - role - scope type: object ListPersistentDisksForAccount_200_response__embedded: properties: persistent_disks: items: $ref: '#/components/schemas/persistent_disk' type: array type: object ListPersistentDisksForAccount_200_response: properties: _embedded: $ref: '#/components/schemas/ListPersistentDisksForAccount_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: $ref: '#/components/schemas/ListActivityReportsForAccount_200_response__links' required: - _embedded - _links - current_page - per_page - total_count type: object ListPlans_200_response__embedded: properties: plans: items: $ref: '#/components/schemas/plan' type: array type: object ListPlans_200_response: properties: _embedded: $ref: '#/components/schemas/ListPlans_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: $ref: '#/components/schemas/ListDatabaseImages_200_response__links' required: - _embedded - _links - current_page - per_page - total_count type: object ListReleasesForService_200_response__embedded: properties: releases: items: $ref: '#/components/schemas/release' type: array type: object ListReleasesForService_200_response: properties: _embedded: $ref: '#/components/schemas/ListReleasesForService_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: $ref: '#/components/schemas/ListDiskAttachmentsForService_200_response__links' required: - _embedded - _links - current_page - per_page - total_count type: object ListServiceSizingPoliciesForAccount_200_response__embedded: properties: service_sizing_policies: items: $ref: '#/components/schemas/service_sizing_policy' type: array type: object ListServiceSizingPoliciesForAccount_200_response: properties: _embedded: $ref: '#/components/schemas/ListServiceSizingPoliciesForAccount_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: $ref: '#/components/schemas/ListActivityReportsForAccount_200_response__links' required: - _embedded - _links - current_page - per_page - total_count type: object UpdateServiceSizingPolicy_request: properties: scaling_enabled: type: boolean metric_lookback_seconds: type: integer percentile: type: number post_scale_up_cooldown_seconds: type: integer post_scale_down_cooldown_seconds: type: integer post_release_cooldown_seconds: type: integer mem_cpu_ratio_r_threshold: type: number mem_cpu_ratio_c_threshold: type: number mem_scale_up_threshold: type: number mem_scale_down_threshold: type: number minimum_memory: type: integer maximum_memory: type: integer autoscaling: type: string min_cpu_threshold: type: number max_cpu_threshold: type: number min_containers: type: integer max_containers: type: integer scale_up_step: type: integer scale_down_step: type: integer use_horizontal_scale: type: boolean type: object ListServicesForAccount_200_response__embedded: properties: services: items: $ref: '#/components/schemas/service' type: array type: object ListServicesForAccount_200_response__links: properties: account: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' app: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' next: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' prev: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object ListServicesForAccount_200_response: properties: _embedded: $ref: '#/components/schemas/ListServicesForAccount_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: $ref: '#/components/schemas/ListServicesForAccount_200_response__links' required: - _embedded - _links - current_page - per_page - total_count type: object UpdateService_request: properties: naive_health_check: type: boolean force_zero_downtime: type: boolean restart_free_scaling: type: boolean stop_timeout: type: integer type: object ListSettingsForApp_200_response__embedded: properties: settings: items: $ref: '#/components/schemas/setting' type: array type: object ListSettingsForApp_200_response: properties: _embedded: $ref: '#/components/schemas/ListSettingsForApp_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: $ref: '#/components/schemas/ListCodeScanResultsForApp_200_response__links' required: - _embedded - _links - current_page - per_page - total_count type: object CreateSettingForApp_request: properties: settings: description: Mapping of non-sensitive key-value pairs type: object sensitive_settings: description: Mapping of sensitive key-value pairs type: object type: object ListSources_200_response__embedded: properties: sources: items: $ref: '#/components/schemas/source' type: array type: object ListSources_200_response: properties: _embedded: $ref: '#/components/schemas/ListSources_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: $ref: '#/components/schemas/ListDatabaseImages_200_response__links' required: - _embedded - _links - current_page - per_page - total_count type: object ListAppsForSource_200_response__links: properties: source: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' next: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' prev: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object ListAppsForSource_200_response: properties: _embedded: $ref: '#/components/schemas/ListAppsForAccount_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: $ref: '#/components/schemas/ListAppsForSource_200_response__links' required: - _embedded - _links - current_page - per_page - total_count type: object ListDeploymentsForSource_200_response: properties: _embedded: $ref: '#/components/schemas/ListDeployments_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: $ref: '#/components/schemas/ListAppsForSource_200_response__links' required: - _embedded - _links - current_page - per_page - total_count type: object ListSshPortalConnectionsForOperation_200_response__embedded: properties: ssh_portal_connections: items: $ref: '#/components/schemas/ssh_portal_connection' type: array type: object ListSshPortalConnectionsForOperation_200_response: properties: _embedded: $ref: '#/components/schemas/ListSshPortalConnectionsForOperation_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: $ref: '#/components/schemas/ListDatabaseImages_200_response__links' required: - _embedded - _links - current_page - per_page - total_count type: object CreateSshPortalConnection_request: properties: ssh_public_key: type: string command: type: string required: - ssh_public_key type: object ListStacks_200_response__embedded: properties: stacks: items: $ref: '#/components/schemas/stack' type: array type: object ListStacks_200_response: properties: _embedded: $ref: '#/components/schemas/ListStacks_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: $ref: '#/components/schemas/ListDatabaseImages_200_response__links' required: - _embedded - _links - current_page - per_page - total_count type: object ListVhostsForAccount_200_response__embedded: properties: vhosts: items: $ref: '#/components/schemas/vhost' type: array type: object ListVhostsForAccount_200_response__links: properties: app: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' service: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' next: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' prev: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object ListVhostsForAccount_200_response: properties: _embedded: $ref: '#/components/schemas/ListVhostsForAccount_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: $ref: '#/components/schemas/ListVhostsForAccount_200_response__links' required: - _embedded - _links - current_page - per_page - total_count type: object CreateVhost_request: properties: type: type: string default: type: boolean x-omitempty: false internal: type: boolean x-omitempty: false certificate: type: integer user_domain: type: string acme: type: boolean x-omitempty: false platform: type: string container_port: type: integer container_ports: items: type: integer type: array ip_whitelist: items: type: string type: array container_exposed_ports: items: type: integer type: array shared: type: boolean load_balancing_algorithm_type: type: string required: - type type: object UpdateVhost_request: properties: user_domain: type: string certificate: type: integer platform: type: string container_port: type: integer container_ports: items: type: integer type: array ip_whitelist: items: type: string type: array shared_fingerprint: type: string shared: type: boolean load_balancing_algorithm_type: type: string type: object ListVpcPeersForStack_200_response__embedded: properties: vpc_peers: items: $ref: '#/components/schemas/vpc_peer' type: array type: object ListVpcPeersForStack_200_response: properties: _embedded: $ref: '#/components/schemas/ListVpcPeersForStack_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: $ref: '#/components/schemas/ListAccountsForStack_200_response__links' required: - _embedded - _links - current_page - per_page - total_count type: object ListVpnTunnelsForStack_200_response__embedded: properties: vpn_tunnels: items: $ref: '#/components/schemas/vpn_tunnel' type: array type: object ListVpnTunnelsForStack_200_response: properties: _embedded: $ref: '#/components/schemas/ListVpnTunnelsForStack_200_response__embedded' total_count: type: integer per_page: type: integer current_page: type: integer _links: $ref: '#/components/schemas/ListAccountsForStack_200_response__links' required: - _embedded - _links - current_page - per_page - total_count type: object account__embedded: properties: log_drains: items: $ref: '#/components/schemas/log_drain' type: array permissions: items: $ref: '#/components/schemas/permission' type: array type: object account__links: properties: organization: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' stack: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' apps: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' backups: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' databases: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' disks: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' services: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' operations: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' permissions: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' log_drains: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' metric_drains: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' certificates: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' vhosts: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' activity_reports: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' disk_attachments: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object activity_report__links: properties: download: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' account: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object app__embedded: properties: services: items: $ref: '#/components/schemas/service' type: array last_operation: $ref: '#/components/schemas/operation' last_deploy_operation: $ref: '#/components/schemas/operation' current_image: $ref: '#/components/schemas/image' type: object app__links: properties: account: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' current_configuration: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' current_image: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' operations: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' images: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' configurations: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' services: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' vhosts: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' ephemeral_sessions: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' service_definitions: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' prerelease_commands: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' code_scan_results: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' last_code_scan_result: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' deployments: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' current_deployment: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' settings: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' current_setting: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object backup_retention_policy__links: properties: account: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object backup__embedded: properties: copied_from: type: object type: object backup__links: properties: account: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' database: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' copied_from: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' database_image: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' copies: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' operations: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object certificate__links: properties: account: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' operations: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' vhosts: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' apps: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object code_scan_result__links: properties: app: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' operation: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object configuration__links: properties: resource: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object container__links: properties: release: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' vhost: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' log_drain: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' metric_drain: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object database_credential__links: properties: database: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' operations: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object database_image__links: properties: database: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object database__embedded: properties: last_operation: $ref: '#/components/schemas/operation' disk: $ref: '#/components/schemas/disk' database_credentials: items: $ref: '#/components/schemas/database_credential' type: array type: object database__links: properties: account: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' database_image: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' service: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' disk: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' initialize_from: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' current_configuration: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' dependents: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' operations: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' backups: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' configurations: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' database_credentials: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' settings: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' current_setting: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object deployment__links: properties: app: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' configuration: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' image: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' source: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' setting: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object disk_attachment__embedded: properties: service: $ref: '#/components/schemas/service' persistent_disk: $ref: '#/components/schemas/persistent_disk' type: object disk_attachment__links: properties: account: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' service: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' persistent_disk: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' operations: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object disk__links: properties: account: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' database: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' operations: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object ephemeral_container__links: properties: ephemeral_session: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' log_drain: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object ephemeral_session__links: properties: app: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' operation: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' ephemeral_containers: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' operations: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object image__links: properties: app: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' operations: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object intrusion_detection_report__links: properties: stack: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' download_csv: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' download_pdf: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object llm_gateway_configuration__links: properties: self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object llm_gateway_key__links: properties: operations: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object llm_key_current_usage: description: Month-to-date usage metrics for this key properties: spend: description: Total spend in USD type: number input_tokens: description: Total input (prompt) tokens type: integer output_tokens: description: Total output (completion) tokens type: integer successful_requests: description: Total successful API requests type: integer failed_requests: description: Total failed API requests type: integer type: object x-nullable: true llm_policy_current_usage: description: Month-to-date usage metrics for this policy properties: spend: description: Total spend in USD type: number input_tokens: description: Total input (prompt) tokens type: integer output_tokens: description: Total output (completion) tokens type: integer successful_requests: description: Total successful API requests type: integer failed_requests: description: Total failed API requests type: integer type: object x-nullable: true log_drain__links: properties: account: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' database: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' operations: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' containers: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' ephemeral_containers: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object maintenance_window__links: properties: self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' account: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' resource: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object metric_drain_drain_configuration: properties: address: format: uri type: string username: type: string password: type: string database: type: string api_key: type: string series_url: format: uri type: string type: object metric_drain__links: properties: account: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' database: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' operations: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' containers: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object operation__links: properties: user: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' resource: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' account: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' destination_account: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' ssh_portal_connections: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' ephemeral_sessions: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' code_scan_result: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' deploy_image: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' service: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object permission__links: properties: role: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' account: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object persistent_disk__links: properties: account: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' operations: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object prerelease_command__links: properties: app: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object release__links: properties: service: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' containers: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object service__links: properties: account: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' current_release: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' app: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' database: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' operations: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' releases: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' vhosts: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' settings: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' current_setting: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object source__links: properties: organization: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' apps: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' deployments: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object ssh_portal_connection__links: properties: operation: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object stack__links: properties: organization: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' accounts: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' intrusion_detection_reports: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' vpn_tunnels: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' vpc_peers: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object vhost_acme_configuration_challenges_inner_from: properties: name: type: string type: object vhost_acme_configuration_challenges_inner_to_inner: properties: name: type: string legacy: type: boolean type: object vhost_acme_configuration_challenges_inner: properties: method: enum: - http01 - dns01 type: string from: $ref: '#/components/schemas/vhost_acme_configuration_challenges_inner_from' to: items: $ref: '#/components/schemas/vhost_acme_configuration_challenges_inner_to_inner' type: array type: object vhost_acme_configuration: properties: names: items: type: string type: array challenges: items: $ref: '#/components/schemas/vhost_acme_configuration_challenges_inner' type: array type: object x-nullable: true vhost__links: properties: service: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' certificate: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' operations: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' settings: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' current_setting: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object vpc_peer__links: properties: stack: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' self: $ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack' type: object securitySchemes: token: in: header name: Authorization type: apiKey