Aptible

Aptible Ephemeral Sessions API

The EphemeralSessions API from Aptible — 3 operation(s) for ephemeralsessions.

Documentation GitHub OpenAPI

Operations 3

GET /apps/{app_id}/ephemeral_sessions list ephemeral_sessions #

GET /ephemeral_sessions/{id} show ephemeral_session #

GET /operations/{operation_id}/ephemeral_sessions list ephemeral_sessions #

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.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/aptible-ephemeralsessions-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

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