> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gcore.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Preview instance price

> Get the price of an instance before you create it. Send the same body that you send to
create an instance. The API reads only the fields that change the price. The price includes
the flavor, the volumes, the ports and the floating IPs. It also includes the existing
volumes, ports and floating IPs that you attach.



## OpenAPI

````yaml /api-reference/services_docs_mintlify_enriched/cloud_api.yaml post /cloud/v1/projects/{project_id}/pricing/instances
openapi: 3.1.0
info:
  title: Gcore OpenAPI – Cloud API
  description: >-
    This OpenAPI is an aggregated OpenAPI specification that unifies all Gcore
    products into a single file. It covers Cloud, CDN, DNS, WAAP, DDoS
    Protection, Object Storage, Streaming, and FastEdge services.
  version: 6f694ac41f91
servers:
  - url: https://api.gcore.com
security:
  - APIKey: []
tags:
  - name: Bare Metal
  - name: Basic VMs
  - name: Container as a Service
  - name: Cost Reports
  - name: DDoS Protection
  - name: Everywhere Inference
  - name: Everywhere Inference Apps
  - name: File Shares
  - name: Floating IPs
  - name: Function as a Service
  - name: GPU Bare Metal
  - name: GPU Virtual
  - name: IP Ranges
  - name: Images
  - name: Instances
  - name: Load Balancers
  - name: Logging
  - name: Managed Kubernetes
  - name: Managed PostgreSQL
  - name: Networks
  - name: Placement Groups
  - name: Ports
  - name: Pricing
  - name: Projects
  - name: Quotas
  - name: Regions
  - name: Registry
  - name: Reservations
  - name: Reserved IPs
  - name: Routers
  - name: SSH Keys
  - name: Secrets
  - name: Security Groups
  - name: Snapshot Schedules
  - name: Snapshots
  - name: Tasks
  - name: User Actions
  - name: User Role Assignments
  - name: Volumes
paths:
  /cloud/v1/projects/{project_id}/pricing/instances:
    post:
      tags:
        - Pricing
      summary: Preview instance price
      description: >-
        Get the price of an instance before you create it. Send the same body
        that you send to

        create an instance. The API reads only the fields that change the price.
        The price includes

        the flavor, the volumes, the ports and the floating IPs. It also
        includes the existing

        volumes, ports and floating IPs that you attach.
      operationId: InstancePricePreviewView.post
      parameters:
        - in: path
          name: project_id
          required: true
          description: Project ID.
          schema:
            description: Project ID.
            example: 1
            examples:
              - 1
            title: Project Id
            type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InstancePricePreviewBodySerializer'
      responses:
        '200':
          description: Instance price
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerPriceSerializer'
        '400':
          $ref: '#/components/responses/ProblemBadRequest'
        '401':
          $ref: '#/components/responses/ProblemUnauthorized'
        '403':
          $ref: '#/components/responses/ProblemForbidden'
        '404':
          $ref: '#/components/responses/ProblemNotFound'
        '409':
          $ref: '#/components/responses/ProblemConflict'
        '500':
          $ref: '#/components/responses/ProblemInternalServerError'
        '503':
          $ref: '#/components/responses/ProblemServiceUnavailable'
components:
  schemas:
    InstancePricePreviewBodySerializer:
      description: The body of the regular create or of the workflow create.
      oneOf:
        - $ref: '#/components/schemas/InstancePricePreviewReferenceBodySerializer'
        - $ref: '#/components/schemas/InstancePricePreviewWorkflowBodySerializer'
      title: InstancePricePreviewBodySerializer
    ServerPriceSerializer:
      properties:
        boot_volume:
          anyOf:
            - $ref: '#/components/schemas/VolumePriceLineSerializer'
            - type: 'null'
          description: Price of the boot volume. Null when the body has no boot volume.
        currency:
          description: Currency code.
          example: USD
          examples:
            - USD
          title: Currency
          type: string
        data_volumes:
          description: Prices of the data volumes, in the order of the request.
          items:
            $ref: '#/components/schemas/VolumePriceLineSerializer'
          title: Data Volumes
          type: array
        egress_traffic:
          anyOf:
            - $ref: '#/components/schemas/EgressTrafficPriceSerializer'
            - type: 'null'
          description: >-
            Rate of the outgoing traffic. It is not part of the totals. Null
            when the traffic of the server has no tariff.
        external_ips:
          $ref: '#/components/schemas/CountedPriceLineSerializer'
          description: Price of the IPv4 addresses that ports have on the public network.
        flavor:
          $ref: '#/components/schemas/FlavorPriceLineSerializer'
          description: Price of the flavor.
        floating_ips:
          $ref: '#/components/schemas/CountedPriceLineSerializer'
          description: >-
            Price of the floating IPs. A floating IP is a separate address that
            maps to a port.
        hourly:
          description: Sum of the hourly prices of all sections.
          example: 0.0621
          examples:
            - 0.0621
          title: Hourly
          type: number
        monthly:
          description: Sum of the monthly prices of all sections.
          example: 44.71
          examples:
            - 44.71
          title: Monthly
          type: number
        monthly_before_discount:
          description: Sum of the monthly prices before the discount.
          example: 48
          examples:
            - 48
          title: Monthly Before Discount
          type: number
        tax_percent:
          description: Tax in percent. The prices include it.
          example: 20
          examples:
            - 20
          title: Tax Percent
          type: number
      required:
        - currency
        - tax_percent
        - hourly
        - monthly
        - monthly_before_discount
        - flavor
        - boot_volume
        - data_volumes
        - external_ips
        - floating_ips
        - egress_traffic
      title: ServerPriceSerializer
      type: object
    InstancePricePreviewReferenceBodySerializer:
      anyOf:
        - required:
            - boot_volume_id
        - required:
            - data_volume_ids
      description: 'The body of the regular create: the volumes exist.'
      properties:
        boot_volume_id:
          description: >-
            Existing boot volume. Omit it to price the server without a boot
            volume.
          format: uuid4
          title: Boot Volume Id
          type: string
        data_volume_ids:
          description: Existing data volumes.
          items:
            format: uuid4
            type: string
          title: Data Volume Ids
          type: array
        flavor_name:
          description: Flavor of the server.
          example: g2-standard-4-8
          examples:
            - g2-standard-4-8
          title: Flavor Name
          type: string
        interfaces:
          description: >-
            Ports in NIC order. An entry with `port_id` is an existing port, any
            other entry is a new one. Omit it to price the server without ports.
          items:
            oneOf:
              - $ref: '#/components/schemas/PricePortReferenceSerializer'
              - $ref: '#/components/schemas/PricePortSpecSerializer'
          title: Interfaces
          type: array
        region_id:
          description: Region of the server.
          example: 7
          examples:
            - 7
          title: Region Id
          type: integer
      required:
        - region_id
        - flavor_name
      title: InstancePricePreviewReferenceBodySerializer
      type: object
    InstancePricePreviewWorkflowBodySerializer:
      description: >-
        The body of the workflow create: each volume is an existing one or a new
        one.
      not:
        anyOf:
          - required:
              - boot_volume_id
          - required:
              - data_volume_ids
      properties:
        boot_volume:
          description: >-
            An entry with `volume_id` is an existing volume, any other entry is
            a new one. Omit it to price the server without a boot volume.
          oneOf:
            - $ref: '#/components/schemas/PriceVolumeReferenceSerializer'
            - $ref: '#/components/schemas/PriceVolumeSpecSerializer'
          title: Boot Volume
        data_volumes:
          description: >-
            An entry with `volume_id` is an existing volume, any other entry is
            a new one.
          items:
            oneOf:
              - $ref: '#/components/schemas/PriceVolumeReferenceSerializer'
              - $ref: '#/components/schemas/PriceVolumeSpecSerializer'
          title: Data Volumes
          type: array
        flavor_name:
          description: Flavor of the server.
          example: g2-standard-4-8
          examples:
            - g2-standard-4-8
          title: Flavor Name
          type: string
        interfaces:
          description: >-
            Ports in NIC order. An entry with `port_id` is an existing port, any
            other entry is a new one. Omit it to price the server without ports.
          items:
            oneOf:
              - $ref: '#/components/schemas/PricePortReferenceSerializer'
              - $ref: '#/components/schemas/PricePortSpecSerializer'
          title: Interfaces
          type: array
        region_id:
          description: Region of the server.
          example: 7
          examples:
            - 7
          title: Region Id
          type: integer
      required:
        - region_id
        - flavor_name
      title: InstancePricePreviewWorkflowBodySerializer
      type: object
    VolumePriceLineSerializer:
      properties:
        discount_percent:
          description: Discount in percent. 0 when there is no discount.
          example: 10
          examples:
            - 10
          title: Discount Percent
          type: number
        hourly:
          description: Price per hour after the discount.
          example: 0.0412
          examples:
            - 0.0412
          title: Hourly
          type: number
        monthly:
          description: Price per month after the discount.
          example: 29.66
          examples:
            - 29.66
          title: Monthly
          type: number
        monthly_before_discount:
          description: Price per month before the discount.
          example: 32.95
          examples:
            - 32.95
          title: Monthly Before Discount
          type: number
        size:
          description: Volume size in GiB. The price uses the size in GB
          example: 20
          examples:
            - 20
          title: Size
          type: integer
        type:
          description: Volume type.
          example: ssd_hiiops
          examples:
            - ssd_hiiops
          title: Type
          type: string
      required:
        - hourly
        - monthly
        - monthly_before_discount
        - discount_percent
        - type
        - size
      title: VolumePriceLineSerializer
      type: object
    EgressTrafficPriceSerializer:
      properties:
        discount_percent:
          description: Discount in percent. 0 when there is no discount.
          example: 16.67
          examples:
            - 16.67
          title: Discount Percent
          type: number
        per_gb:
          description: Price of one GB of used traffic after the discount.
          example: 0.01
          examples:
            - 0.01
          title: Per Gb
          type: number
        per_gb_before_discount:
          description: Price of one GB before the discount.
          example: 0.012
          examples:
            - 0.012
          title: Per Gb Before Discount
          type: number
      required:
        - per_gb
        - per_gb_before_discount
        - discount_percent
      title: EgressTrafficPriceSerializer
      type: object
    CountedPriceLineSerializer:
      properties:
        count:
          description: Number of IP addresses. 0 when the server has none.
          example: 1
          examples:
            - 1
          title: Count
          type: integer
        discount_percent:
          description: Discount in percent. 0 when there is no discount.
          example: 10
          examples:
            - 10
          title: Discount Percent
          type: number
        hourly:
          description: Price per hour after the discount.
          example: 0.0412
          examples:
            - 0.0412
          title: Hourly
          type: number
        monthly:
          description: Price per month after the discount.
          example: 29.66
          examples:
            - 29.66
          title: Monthly
          type: number
        monthly_before_discount:
          description: Price per month before the discount.
          example: 32.95
          examples:
            - 32.95
          title: Monthly Before Discount
          type: number
      required:
        - hourly
        - monthly
        - monthly_before_discount
        - discount_percent
        - count
      title: CountedPriceLineSerializer
      type: object
    FlavorPriceLineSerializer:
      properties:
        count:
          description: Number of servers. The create makes one server.
          example: 1
          examples:
            - 1
          title: Count
          type: integer
        discount_percent:
          description: Discount in percent. 0 when there is no discount.
          example: 10
          examples:
            - 10
          title: Discount Percent
          type: number
        hourly:
          description: Price per hour after the discount.
          example: 0.0412
          examples:
            - 0.0412
          title: Hourly
          type: number
        monthly:
          description: Price per month after the discount.
          example: 29.66
          examples:
            - 29.66
          title: Monthly
          type: number
        monthly_before_discount:
          description: Price per month before the discount.
          example: 32.95
          examples:
            - 32.95
          title: Monthly Before Discount
          type: number
        name:
          description: Flavor name.
          example: g2-standard-4-8
          examples:
            - g2-standard-4-8
          title: Name
          type: string
      required:
        - hourly
        - monthly
        - monthly_before_discount
        - discount_percent
        - name
        - count
      title: FlavorPriceLineSerializer
      type: object
    Problem:
      additionalProperties: false
      description: The error body, served as `application/problem+json`.
      properties:
        context:
          anyOf:
            - $ref: '#/components/schemas/ProblemContext'
            - type: 'null'
          default: null
          description: >-
            Data for the `type`. Absent on a type without context keys, and on a
            `not-found` for an unknown URL.
        detail:
          description: The facts of this occurrence.
          title: Detail
          type: string
        errors:
          anyOf:
            - items:
                $ref: '#/components/schemas/ProblemError'
              type: array
            - type: 'null'
          default: null
          description: >-
            One item for each invalid input. Only on `validation-error`, and
            absent when no single input is wrong.
          title: Errors
        hint:
          description: What to do next.
          title: Hint
          type: string
        request_id:
          description: >-
            ID of the request. The response also sends it in the `X-Request-Id`
            header. Quote it to support.
          title: Request Id
          type: string
        status:
          description: Copy of the HTTP status code.
          title: Status
          type: integer
        title:
          description: Fixed sentence for the `type`.
          title: Title
          type: string
        trace_id:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            W3C trace ID from the `traceparent` of the request. Null when the
            request has no valid `traceparent`.
          title: Trace Id
        type:
          $ref: '#/components/schemas/ProblemType'
          description: >-
            Stable error code in kebab-case, such as `not-found`. Clients branch
            on it. It is not `errors[].code`, which names what is wrong with one
            input in `snake_case`, such as `not_found`.
      required:
        - type
        - title
        - status
        - detail
        - hint
        - request_id
        - trace_id
      title: Problem
      type: object
    PricePortReferenceSerializer:
      properties:
        floating_ip:
          $ref: '#/components/schemas/PriceFloatingIpSerializer'
          description: Floating IP of the port.
        port_id:
          description: Existing port.
          format: uuid4
          title: Port Id
          type: string
      required:
        - port_id
      title: PricePortReferenceSerializer
      type: object
    PricePortSpecSerializer:
      properties:
        floating_ip:
          $ref: '#/components/schemas/PriceFloatingIpSerializer'
          description: Floating IP of the new port.
        ip_assignments:
          description: >-
            IP addresses of the new port. Omit the field to get one address from
            an IPv4 subnet.
          items:
            $ref: '#/components/schemas/IpAssignmentRequestSerializer'
          maxItems: 64
          minItems: 1
          title: Ip Assignments
          type: array
        network_id:
          description: >-
            Network of the new port. When omitted, it is the network of the
            subnets in `ip_assignments`, or the public network of the region if
            `ip_assignments` is omitted.
          format: uuid4
          title: Network Id
          type: string
      title: PricePortSpecSerializer
      type: object
    PriceVolumeReferenceSerializer:
      properties:
        volume_id:
          description: Existing volume.
          format: uuid4
          title: Volume Id
          type: string
      required:
        - volume_id
      title: PriceVolumeReferenceSerializer
      type: object
    PriceVolumeSpecSerializer:
      properties:
        size:
          description: >-
            Size in GiB. Required for a blank or image volume. A volume from a
            snapshot or a volume has the size of its source, and a larger size
            grows it.
          exclusiveMaximum: 102400
          exclusiveMinimum: 0
          title: Size
          type: integer
        source:
          $ref: '#/components/schemas/WorkflowVolumeSourceSerializer'
          description: >-
            Image, snapshot or volume to create the volume from. Omit it for a
            blank volume.
        type:
          $ref: '#/components/schemas/AllVolumeTypeEnum'
          description: >-
            Volume type. A volume from a snapshot or a volume has the type of
            its source. Any other volume is `standard` by default.
          examples:
            - ssd_hiiops
      title: PriceVolumeSpecSerializer
      type: object
    ProblemContext:
      additionalProperties: false
      description: >-
        Data for the `type`. One flat object shared by all types. Each `type`
        always sends the same keys, and a key that the server cannot fill is
        `null`. The keys of each type:

        - `resource-in-use`: `blocking_resources`, `blocking_count`

        - `quota-exceeded`: `quotas`

        - `not-available`: `reason`, `region_id`, `resource_type`, `resource_id`

        - `permission-denied`: `operation`, `client_id`, `project_id`

        - `not-found`: `resource_type`, `resource_id`

        - `method-not-allowed`: `allowed_methods`

        - `resource-busy`: `resource_type`, `resource_id`, `resource_status`

        - `rate-limited`: `retry_after`

        - `service-unavailable`: `retry_after`

        The other types send no `context`, and neither does a `not-found` for an
        unknown URL.
      properties:
        allowed_methods:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          default: null
          description: Methods that the endpoint supports.
          title: Allowed Methods
        blocking_count:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          description: Total number of blocking resources.
          title: Blocking Count
        blocking_resources:
          anyOf:
            - items:
                $ref: '#/components/schemas/ProblemBlockingResource'
              type: array
            - type: 'null'
          default: null
          description: At most 50 resources that block the request.
          title: Blocking Resources
        client_id:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          description: The account of the operation.
          title: Client Id
        operation:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Name of the operation that the credentials lack.
          title: Operation
        project_id:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          description: The project of the operation.
          title: Project Id
        quotas:
          anyOf:
            - items:
                $ref: '#/components/schemas/ProblemQuota'
              type: array
            - type: 'null'
          default: null
          description: The quotas that the request exceeds.
          title: Quotas
        reason:
          anyOf:
            - $ref: '#/components/schemas/NotAvailableReason'
            - type: 'null'
          default: null
          description: Why the resource is not available.
        region_id:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          description: The region of the error.
          title: Region Id
        resource_id:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: ID or name of the resource.
          title: Resource Id
        resource_status:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Current status of the resource.
          title: Resource Status
        resource_type:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Type of the resource, as the permissions name it, such as
            `instances`.
          title: Resource Type
        retry_after:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          description: >-
            Seconds to wait before the next request. `null` when the server
            cannot tell.
          title: Retry After
      title: ProblemContext
      type: object
    ProblemError:
      additionalProperties: false
      description: One invalid input.
      properties:
        code:
          description: >-
            What is wrong, as a code from a fixed list, such as `missing`,
            `int_parsing` or `less_than_equal`, or one of the shared codes:
            `not_unique`, `not_found`, `mutually_exclusive`, `missing_one_of`,
            `incompatible_value`, `invalid_format`, `duplicate_item`,
            `invalid_status`. Codes are only added, never renamed or removed.
            Treat an unknown code like `value_error`.
          type: string
        ctx:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          default: null
          description: >-
            Values of the broken constraint, such as `{"le": 4096}`. Absent when
            the check has no values.
          title: Ctx
        detail:
          description: What is wrong with the input.
          title: Detail
          type: string
        loc:
          description: >-
            Path to the input. Starts with `body`, `query`, `path` or `header`.
            A query filter is the parameter, then the operator: `name[contains]`
            is `["query", "name", "contains"]`.
          items:
            anyOf:
              - type: string
              - type: integer
          title: Loc
          type: array
      required:
        - loc
        - code
        - detail
      title: ProblemError
      type: object
    ProblemType:
      enum:
        - internal-server-error
        - method-not-allowed
        - not-available
        - not-found
        - permission-denied
        - quota-exceeded
        - rate-limited
        - resource-busy
        - resource-in-use
        - service-unavailable
        - unauthorized
        - validation-error
      title: ProblemType
      type: string
    PriceFloatingIpSerializer:
      properties:
        floating_ip_id:
          description: Existing floating IP. Omit it for a new floating IP.
          format: uuid4
          title: Floating Ip Id
          type: string
      title: PriceFloatingIpSerializer
      type: object
    IpAssignmentRequestSerializer:
      additionalProperties: false
      properties:
        ip_address:
          anyOf:
            - format: ipv4
              type: string
            - format: ipv6
              type: string
          description: >-
            IP address to assign. Omit it to get any free address of the subnet,
            which is the only option when the subnet's free addresses are not
            known to the caller.
          examples:
            - 192.168.123.20
          title: Ip Address
        subnet_id:
          description: ID of the subnet
          example: b39792c3-3160-4356-912e-ba396c95cdcf
          examples:
            - b39792c3-3160-4356-912e-ba396c95cdcf
          format: uuid4
          title: Subnet Id
          type: string
      required:
        - subnet_id
      title: IpAssignmentRequestSerializer
      type: object
    WorkflowVolumeSourceSerializer:
      additionalProperties: false
      properties:
        id:
          description: >-
            ID of the image, the snapshot or the volume to clone. Only a source
            volume of type `standard` or `ssd_hiiops` can be cloned.
          format: uuid4
          title: Id
          type: string
        type:
          $ref: '#/components/schemas/VolumeSourceType'
          description: What the volume is created from.
      required:
        - type
        - id
      title: WorkflowVolumeSourceSerializer
      type: object
    AllVolumeTypeEnum:
      enum:
        - cold
        - ssd_hiiops
        - ssd_local
        - ssd_lowlatency
        - standard
        - ultra
      title: AllVolumeTypeEnum
      type: string
    ProblemBlockingResource:
      additionalProperties: false
      description: One resource that blocks the request.
      properties:
        resource_id:
          description: ID of the blocking resource.
          title: Resource Id
          type: string
        resource_name:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Name of the blocking resource.
          title: Resource Name
        resource_type:
          description: >-
            Type of the blocking resource, as the permissions name it, such as
            `ports`.
          title: Resource Type
          type: string
      required:
        - resource_type
        - resource_id
      title: ProblemBlockingResource
      type: object
    ProblemQuota:
      additionalProperties: false
      description: One quota that the request exceeds.
      properties:
        available:
          anyOf:
            - type: integer
            - type: number
          description: '`limit` minus `usage`.'
          title: Available
        limit:
          anyOf:
            - type: integer
            - type: number
          description: The limit of the quota.
          title: Limit
        name:
          description: Quota name, such as `vm_count`.
          title: Name
          type: string
        overflow:
          anyOf:
            - type: integer
            - type: number
          description: 'The amount above the limit: `resulting_usage` minus `limit`.'
          title: Overflow
        region_id:
          anyOf:
            - type: integer
            - type: 'null'
          description: >-
            Region of a regional quota. `null` for a global quota, or when
            unknown.
          title: Region Id
        requested:
          anyOf:
            - type: integer
            - type: number
          description: The amount that the request adds.
          title: Requested
        resulting_usage:
          anyOf:
            - type: integer
            - type: number
          description: 'The usage after the request: `usage` plus `requested`.'
          title: Resulting Usage
        scope:
          anyOf:
            - $ref: '#/components/schemas/QuotaScope'
            - type: 'null'
          description: >-
            `regional` for a quota of one region, `global` for a quota of the
            account. `null` when the server cannot tell.
        unit:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Unit of the numbers, such as `MiB`, `GiB` or `bytes`. `null` for a
            quota that counts items.
          title: Unit
        usage:
          anyOf:
            - type: integer
            - type: number
          description: The usage before the request.
          title: Usage
      required:
        - name
        - scope
        - region_id
        - limit
        - usage
        - available
        - requested
        - resulting_usage
        - overflow
        - unit
      title: ProblemQuota
      type: object
    NotAvailableReason:
      enum:
        - account
        - balance
        - capacity
        - plan
        - region
      title: NotAvailableReason
      type: string
    VolumeSourceType:
      enum:
        - image
        - snapshot
        - volume
      title: VolumeSourceType
      type: string
    QuotaScope:
      enum:
        - global
        - regional
      title: QuotaScope
      type: string
  responses:
    ProblemBadRequest:
      description: >-
        The request cannot succeed as it is. `type` is `validation-error`,
        `resource-in-use`, `quota-exceeded` or `not-available`.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
        Content-Language:
          $ref: '#/components/headers/ContentLanguage'
    ProblemUnauthorized:
      description: The request has no valid credentials. `type` is `unauthorized`.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
        Content-Language:
          $ref: '#/components/headers/ContentLanguage'
    ProblemForbidden:
      description: >-
        The credentials do not permit the operation, or another service manages
        the resource. `type` is `permission-denied`.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
        Content-Language:
          $ref: '#/components/headers/ContentLanguage'
    ProblemNotFound:
      description: The resource or the URL does not exist. `type` is `not-found`.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
        Content-Language:
          $ref: '#/components/headers/ContentLanguage'
    ProblemConflict:
      description: >-
        The resource is in a transient state. `type` is `resource-busy`. Send
        the same request again after the `Retry-After` seconds.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
        Content-Language:
          $ref: '#/components/headers/ContentLanguage'
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
    ProblemInternalServerError:
      description: >-
        The server cannot complete the request. `type` is
        `internal-server-error`.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
        Content-Language:
          $ref: '#/components/headers/ContentLanguage'
    ProblemServiceUnavailable:
      description: >-
        The service is down for a known reason, such as planned maintenance.
        `type` is `service-unavailable`. A 503 without the
        `application/problem+json` media type, and every 502 and 504, comes from
        the gateway and has no problem body.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
        Content-Language:
          $ref: '#/components/headers/ContentLanguage'
  headers:
    RequestId:
      description: The ID of the request, the same as `request_id` in the body.
      schema:
        type: string
    ContentLanguage:
      description: >-
        The language of `title`, `detail`, `hint` and `errors[].detail`, from
        the `Accept-Language` of the request. Any other field is the same in
        every language.
      schema:
        type: string
        enum:
          - en
          - de
          - ru
          - az
          - zh
          - fr
          - es
          - pt
          - ko
          - ja
          - tr
    RetryAfter:
      description: >-
        The number of seconds to wait before the client sends the same request
        again.
      schema:
        type: integer
        minimum: 0
        maximum: 60
  securitySchemes:
    APIKey:
      description: >-
        API key for authentication. Make sure to include the word `apikey`,
        followed by a single space and then your token.

        Example: `apikey 1234_abcdef`
      type: apiKey
      in: header
      name: Authorization

````