Aptible Settings API
The Settings API from Aptible — 5 operation(s) for settings.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/aptible-settings-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
OpenAPI Specification
openapi: 3.2.0
info:
title: Aptible Settings API
version: v1
contact:
email: support@aptible.com
description: 'Operations tagged Settings across 2 of this provider''s published API definitions: aptible-deploy-openapi-original.yml, aptible-settings-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: '{baseUrl}'
variables:
baseUrl:
default: https://api.aptible.com
description: Override for local or test environments
security:
- token: []
tags:
- name: Settings
paths:
/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
servers:
- url: '{baseUrl}'
variables:
baseUrl:
default: https://api.aptible.com
description: Override for local or test environments
/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
servers:
- url: '{baseUrl}'
variables:
baseUrl:
default: https://api.aptible.com
description: Override for local or test environments
/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
servers:
- url: '{baseUrl}'
variables:
baseUrl:
default: https://api.aptible.com
description: Override for local or test environments
/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
servers:
- url: '{baseUrl}'
variables:
baseUrl:
default: https://api.aptible.com
description: Override for local or test environments
/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
servers:
- url: '{baseUrl}'
variables:
baseUrl:
default: https://api.aptible.com
description: Override for local or test environments
components:
schemas:
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
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
ListAccountsForStack_200_response__links_stack:
properties:
href:
format: uri
type: string
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
configuration__links:
properties:
resource:
$ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack'
self:
$ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack'
type: object
error:
properties:
code:
type: integer
error:
type: string
message:
type: string
required:
- code
- error
- message
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
ListSettingsForApp_200_response__embedded:
properties:
settings:
items:
$ref: '#/components/schemas/setting'
type: array
type: object
securitySchemes:
token:
in: header
name: Authorization
type: apiKey
x-refined-from:
- aptible-deploy-openapi-original.yml
- aptible-settings-api-openapi.yml