Aptible Deployments API
The Deployments API from Aptible — 3 operation(s) for deployments.
The Deployments API from Aptible — 3 operation(s) for deployments.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/aptible-deployments-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
openapi: 3.2.0
info:
title: Aptible Deployments API
version: v1
contact:
email: support@aptible.com
description: 'Operations tagged Deployments across 2 of this provider''s published API definitions: aptible-deploy-openapi-original.yml, aptible-deployments-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: Deployments
paths:
/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
servers:
- url: '{baseUrl}'
variables:
baseUrl:
default: https://api.aptible.com
description: Override for local or test environments
/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
servers:
- url: '{baseUrl}'
variables:
baseUrl:
default: https://api.aptible.com
description: Override for local or test environments
/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
servers:
- url: '{baseUrl}'
variables:
baseUrl:
default: https://api.aptible.com
description: Override for local or test environments
components:
schemas:
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
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
ListAccountsForStack_200_response__links_stack:
properties:
href:
format: uri
type: string
type: object
ListDeployments_200_response__embedded:
properties:
deployments:
items:
$ref: '#/components/schemas/deployment'
type: array
type: object
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
error:
properties:
code:
type: integer
error:
type: string
message:
type: string
required:
- code
- error
- message
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
securitySchemes:
token:
in: header
name: Authorization
type: apiKey
x-refined-from:
- aptible-deploy-openapi-original.yml
- aptible-deployments-api-openapi.yml