Aptible Services API
The Services API from Aptible — 3 operation(s) for services.
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-services-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 Services API
version: v1
contact:
email: support@aptible.com
description: 'Operations tagged Services across 2 of this provider''s published API definitions: aptible-deploy-openapi-original.yml, aptible-services-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: Services
paths:
/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
servers:
- url: '{baseUrl}'
variables:
baseUrl:
default: https://api.aptible.com
description: Override for local or test environments
/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
servers:
- url: '{baseUrl}'
variables:
baseUrl:
default: https://api.aptible.com
description: Override for local or test environments
/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
servers:
- url: '{baseUrl}'
variables:
baseUrl:
default: https://api.aptible.com
description: Override for local or test environments
components:
schemas:
ListServicesForAccount_200_response__embedded:
properties:
services:
items:
$ref: '#/components/schemas/service'
type: array
type: object
ListAccountsForStack_200_response__links_stack:
properties:
href:
format: uri
type: string
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
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
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
error:
properties:
code:
type: integer
error:
type: string
message:
type: string
required:
- code
- error
- message
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
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
securitySchemes:
token:
in: header
name: Authorization
type: apiKey
x-refined-from:
- aptible-deploy-openapi-original.yml
- aptible-services-api-openapi.yml