Aptible Claims API

openapi: 3.2.0
info:
  title: Aptible Claims API
  version: v1
  contact:
    email: support@aptible.com
  description: 'Operations tagged Claims across 2 of this provider''s published API definitions: aptible-claims-api-openapi.yml, aptible-deploy-openapi-original.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: Claims
paths:
  /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
    servers:
    - url: '{baseUrl}'
      variables:
        baseUrl:
          default: https://api.aptible.com
          description: Override for local or test environments
  /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
    servers:
    - url: '{baseUrl}'
      variables:
        baseUrl:
          default: https://api.aptible.com
          description: Override for local or test environments
  /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
    servers:
    - url: '{baseUrl}'
      variables:
        baseUrl:
          default: https://api.aptible.com
          description: Override for local or test environments
components:
  schemas:
    CreateClaim_request:
      properties:
        type:
          enum:
          - app
          - database
          - account
          type: string
        handle:
          type: string
      required:
      - type
      type: object
    CreateApp_request:
      properties:
        handle:
          type: string
      required:
      - handle
      type: object
    CreateClaimForType_request:
      properties:
        handle:
          type: string
      type: object
    error:
      properties:
        code:
          type: integer
        error:
          type: string
        message:
          type: string
      required:
      - code
      - error
      - message
      type: object
  securitySchemes:
    token:
      in: header
      name: Authorization
      type: apiKey
x-refined-from:
- aptible-claims-api-openapi.yml
- aptible-deploy-openapi-original.yml