> ## 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.

# List basic VMs

> List the basic VMs of a project in all regions.



## OpenAPI

````yaml /api-reference/services_docs_mintlify_enriched/cloud_api.yaml get /cloud/v1/projects/{project_id}/basic_vms
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}/basic_vms:
    get:
      tags:
        - Basic VMs
      summary: List basic VMs
      description: List the basic VMs of a project in all regions.
      operationId: GlobalBasicVmListView.get
      parameters:
        - in: path
          name: project_id
          required: true
          description: Project ID.
          schema:
            description: Project ID.
            example: 1
            examples:
              - 1
            title: Project Id
            type: integer
        - in: query
          name: created_at
          required: false
          description: Filter by the creation time.
          schema:
            $ref: '#/components/schemas/DateTimeRangeFilter'
            description: Filter by the creation time.
          style: deepObject
          explode: true
        - in: query
          name: flavor_name
          required: false
          description: Filter by flavor name, e.g. `flavor_name[prefix]=g2s-`.
          schema:
            $ref: '#/components/schemas/StringFilter'
            description: Filter by flavor name, e.g. `flavor_name[prefix]=g2s-`.
          style: deepObject
          explode: true
        - in: query
          name: ids
          required: false
          description: Filter by basic VM IDs.
          schema:
            description: Filter by basic VM IDs.
            items:
              format: uuid4
              type: string
            title: Ids
            type: array
        - in: query
          name: ip_address
          required: false
          description: Filter by an IP address of a port of the basic VM.
          schema:
            $ref: '#/components/schemas/IpAddressFilter'
            description: Filter by an IP address of a port of the basic VM.
          style: deepObject
          explode: true
        - in: query
          name: limit
          required: false
          description: Maximum number of items to return.
          schema:
            default: 100
            description: Maximum number of items to return.
            exclusiveMinimum: 0
            maximum: 1000
            title: Limit
            type: integer
        - in: query
          name: name
          required: false
          description: Filter by name, e.g. `name[contains]=web`.
          schema:
            $ref: '#/components/schemas/StringFilter'
            description: Filter by name, e.g. `name[contains]=web`.
          style: deepObject
          explode: true
        - in: query
          name: network_ids
          required: false
          description: Filter by the networks of the ports of the basic VM.
          schema:
            description: Filter by the networks of the ports of the basic VM.
            items:
              format: uuid4
              type: string
            title: Network Ids
            type: array
        - in: query
          name: offset
          required: false
          description: Number of items to skip.
          schema:
            default: 0
            description: Number of items to skip.
            minimum: 0
            title: Offset
            type: integer
        - in: query
          name: order_by
          required: false
          description: Sort field and direction.
          schema:
            $ref: '#/components/schemas/GlobalBasicVmListOrderBy'
            default: created_at.desc
            description: Sort field and direction.
        - in: query
          name: region_ids
          required: false
          description: Filter by region IDs. Omit it to get all regions.
          schema:
            description: Filter by region IDs. Omit it to get all regions.
            items:
              type: integer
            title: Region Ids
            type: array
        - in: query
          name: security_group_ids
          required: false
          description: Filter by security group IDs.
          schema:
            description: Filter by security group IDs.
            items:
              format: uuid4
              type: string
            title: Security Group Ids
            type: array
        - in: query
          name: statuses
          required: false
          description: Filter by statuses.
          schema:
            description: Filter by statuses.
            items:
              $ref: '#/components/schemas/ResourceStatus'
            title: Statuses
            type: array
        - in: query
          name: subnet_ids
          required: false
          description: Filter by subnet IDs.
          schema:
            description: Filter by subnet IDs.
            items:
              format: uuid4
              type: string
            title: Subnet Ids
            type: array
        - in: query
          name: tag_key
          required: false
          description: >-
            Filter by tag key regardless of value, e.g.
            `tag_key[contains]=team`.
          schema:
            $ref: '#/components/schemas/StringFilter'
            description: >-
              Filter by tag key regardless of value, e.g.
              `tag_key[contains]=team`.
          style: deepObject
          explode: true
        - in: query
          name: tag_value
          required: false
          description: >-
            Filter by tag value regardless of key, e.g.
            `tag_value[prefix]=prod`.
          schema:
            $ref: '#/components/schemas/StringFilter'
            description: >-
              Filter by tag value regardless of key, e.g.
              `tag_value[prefix]=prod`.
          style: deepObject
          explode: true
        - in: query
          name: tags
          required: false
          description: >-
            Filter by exact tag key-value pairs, e.g.
            `tags[env]=prod&tags[team]=core`. Repeat a key to match any of
            several values for it, e.g. `tags[env]=prod&tags[env]=dev`. Values
            for one key are ORed, different keys are ANDed; values match
            case-insensitively.
          schema:
            $ref: '#/components/schemas/TagFilter'
            description: >-
              Filter by exact tag key-value pairs, e.g.
              `tags[env]=prod&tags[team]=core`. Repeat a key to match any of
              several values for it, e.g. `tags[env]=prod&tags[env]=dev`. Values
              for one key are ORed, different keys are ANDed; values match
              case-insensitively.
            examples:
              - env:
                  - prod
          style: deepObject
          explode: true
        - in: query
          name: updated_at
          required: false
          description: Filter by the time of the last update.
          schema:
            $ref: '#/components/schemas/DateTimeRangeFilter'
            description: Filter by the time of the last update.
          style: deepObject
          explode: true
      responses:
        '200':
          description: Basic VMs
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalBasicVmCollectionSerializer'
        '400':
          $ref: '#/components/responses/ProblemBadRequestOnRead'
        '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:
    DateTimeRangeFilter:
      additionalProperties: false
      description: >-
        Filter a timestamp field by a date/time range.


        Set a lower bound with `gt` (after) or `gte` (at or after), and an upper
        bound

        with `lt` (before) or `lte` (at or before). Use one or both; together
        they form

        a range. Values are in `2026-01-01T00:00:00Z` format, UTC.


        Examples:


        - `created_at[gte]=2026-01-01T00:00:00Z` - created on or after Jan 1.

        -
        `created_at[gte]=2026-01-01T00:00:00Z&created_at[lt]=2026-02-01T00:00:00Z`
          - created during January.

        Pass at most one lower and one upper bound; two lower or two upper
        bounds is a

        400.
      properties:
        gt:
          description: Strictly after this timestamp, e.g. `[gt]=2026-01-01T00:00:00Z`.
          format: date-time
          title: Gt
          type: string
        gte:
          description: >-
            At or after this timestamp (inclusive), e.g.
            `[gte]=2026-01-01T00:00:00Z`.
          format: date-time
          title: Gte
          type: string
        lt:
          description: Strictly before this timestamp, e.g. `[lt]=2026-02-01T00:00:00Z`.
          format: date-time
          title: Lt
          type: string
        lte:
          description: >-
            At or before this timestamp (inclusive), e.g.
            `[lte]=2026-02-01T00:00:00Z`.
          format: date-time
          title: Lte
          type: string
      title: DateTimeRangeFilter
      type: object
    StringFilter:
      additionalProperties: false
      description: >-
        Filter a string field by one or more operators.


        Use `exact`, `prefix`, `contains` or `suffix`; all match
        case-insensitively.

        Repeat one operator to match any of several values; combine different
        operators

        to narrow the result.


        Examples:


        - `name[contains]=web` - name contains "web".

        - `name[prefix]=prod-` - name starts with "prod-".

        - `name[prefix]=prod-&name[contains]=web` - both must hold.


        Unsupported operators return a 400.
      properties:
        contains:
          description: >-
            Case-insensitive substring, e.g. `[contains]=web`. Repeat the key to
            match any substring.
          items:
            type: string
          maxItems: 5
          title: Contains
          type: array
        exact:
          description: >-
            Case-insensitive exact match, e.g. `[exact]=web-1`. Repeat the key
            to match any of several.
          items:
            type: string
          maxItems: 20
          title: Exact
          type: array
        prefix:
          description: >-
            Case-insensitive starts-with, e.g. `[prefix]=prod-`. Repeat the key
            to match any prefix.
          items:
            type: string
          maxItems: 5
          title: Prefix
          type: array
        suffix:
          description: >-
            Case-insensitive ends-with, e.g. `[suffix]=-db`. Repeat the key to
            match any suffix.
          items:
            type: string
          maxItems: 5
          title: Suffix
          type: array
      title: StringFilter
      type: object
    IpAddressFilter:
      additionalProperties: false
      description: >-
        Filter by IP address against any of the resource's port fixed IPs.


        `exact` matches full addresses; `contains` matches substrings (partial
        IP).

        Repeat the key to match any of several values.


        Examples:


        - `ip_address[exact]=192.168.1.10` - has a port with this IP.

        - `ip_address[exact]=192.168.1.10&ip_address[exact]=10.0.0.5` - has
        either IP.

        - `ip_address[contains]=192.168` - has a port whose IP contains
        "192.168".


        Unsupported operators (e.g. `prefix`) return a 400.
      properties:
        contains:
          description: >-
            Substring match on IP address, e.g. `[contains]=192.168`. Repeat the
            key to match any substring.
          items:
            type: string
          maxItems: 5
          title: Contains
          type: array
        exact:
          description: >-
            Exact IP match, e.g. `[exact]=192.168.1.10`. Repeat the key to match
            any of several.
          items:
            format: ipvanyaddress
            type: string
          maxItems: 20
          title: Exact
          type: array
      title: IpAddressFilter
      type: object
    GlobalBasicVmListOrderBy:
      enum:
        - created_at.asc
        - created_at.desc
        - name.asc
        - name.desc
        - region_id.asc
        - region_id.desc
        - status.asc
        - status.desc
      title: GlobalBasicVmListOrderBy
      type: string
    ResourceStatus:
      description: >-
        Lifecycle status of the resource. All resource types use the same
        values.
      enum:
        - active
        - deleted
        - deleting
        - error
        - provisioning
        - rebooting
        - rebuilding
        - resizing
        - stopped
        - unknown
        - updating
      title: ResourceStatus
      type: string
    TagFilter:
      description: >-
        Exact tag key-value pair filter, e.g. `tags[env]=prod&tags[team]=core`.


        Repeat a key to match any of several values for it

        (`tags[env]=prod&tags[env]=dev` -> the `env` tag is prod OR dev);
        different

        keys are ANDed. Values match case-insensitively.
      propertyNames:
        description: >-
          Tag key. Maximum 255 characters. Cannot contain spaces, tabs,
          newlines, empty string or '=' character. Cannot contain characters
          from U+0080 to U+00FF. Trailing or leading whitespaces will be
          stripped.
        examples:
          - my-tag
        maxLength: 255
        minLength: 1
        pattern: ^[^\s=]+$
      title: TagFilter
      type: object
      additionalProperties:
        items:
          description: >-
            Tag value. Maximum 255 characters. Cannot contain tabs, newlines, or
            empty strings. Cannot contain characters from U+0080 to U+00FF.
            Trailing or leading whitespaces will be stripped.
          example: my-tag-value
          examples:
            - my-tag-value
          maxLength: 255
          minLength: 1
          pattern: ^[^ \t\n\r\f\v]([^\t\n\r\f\v]*[^ \t\n\r\f\v])?$
          type: string
        maxItems: 20
        minItems: 1
        type: array
    GlobalBasicVmCollectionSerializer:
      properties:
        count:
          description: Number of objects
          example: 1
          examples:
            - 1
          minimum: 0
          title: Count
          type: integer
        results:
          description: Objects
          items:
            $ref: '#/components/schemas/GlobalBasicVmSerializer'
          title: Results
          type: array
      required:
        - count
        - results
      title: GlobalBasicVmCollectionSerializer
      type: object
    GlobalBasicVmSerializer:
      properties:
        created_at:
          description: Date and time when the basic VM was created.
          format: date-time
          title: Created At
          type: string
        flavor_name:
          description: Flavor name.
          title: Flavor Name
          type: string
        id:
          description: Basic VM ID.
          format: uuid4
          title: Id
          type: string
        interfaces:
          description: Network interfaces of the basic VM. Each interface is a port.
          items:
            $ref: '#/components/schemas/GlobalInstanceInterfaceSerializer'
          title: Interfaces
          type: array
        name:
          description: Basic VM name.
          title: Name
          type: string
        region_id:
          description: Region ID.
          title: Region Id
          type: integer
        ssh_key_id:
          anyOf:
            - format: uuid4
              type: string
            - type: 'null'
          description: ID of the SSH key of the default user, or null.
          title: Ssh Key Id
        status:
          $ref: '#/components/schemas/ResourceStatus'
          description: Status of the basic VM.
        system_tags:
          additionalProperties:
            type: string
          description: Key-value tags that the API sets. You cannot change them.
          title: System Tags
          type: object
        tags:
          additionalProperties:
            type: string
          description: Key-value tags that you set.
          title: Tags
          type: object
        updated_at:
          description: Date and time of the last update of the basic VM.
          format: date-time
          title: Updated At
          type: string
      required:
        - id
        - name
        - status
        - region_id
        - flavor_name
        - ssh_key_id
        - interfaces
        - created_at
        - updated_at
        - tags
        - system_tags
      title: GlobalBasicVmSerializer
      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
    GlobalInstanceInterfaceSerializer:
      properties:
        floating_ip:
          anyOf:
            - format: ipvanyaddress
              type: string
            - type: 'null'
          description: Public floating IP NAT-ing this interface, if any.
          examples:
            - 5.188.135.29
          title: Floating Ip
        ip_assignments:
          description: Fixed IPs assigned to the port.
          items:
            $ref: '#/components/schemas/PortIpAssignmentSerializer'
          title: Ip Assignments
          type: array
        mac_address:
          description: Port MAC address.
          example: fa:16:3e:00:00:01
          examples:
            - fa:16:3e:00:00:01
          title: Mac Address
          type: string
        network_id:
          description: Network the port is attached to.
          format: uuid4
          title: Network Id
          type: string
        port_id:
          description: ID of the port that connects the server to the network.
          format: uuid4
          title: Port Id
          type: string
      required:
        - port_id
        - network_id
        - mac_address
        - ip_assignments
        - floating_ip
      title: GlobalInstanceInterfaceSerializer
      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
    PortIpAssignmentSerializer:
      properties:
        ip_address:
          description: The IP address assigned to the port from the specified subnet
          example: 192.168.123.20
          examples:
            - 192.168.123.20
          format: ipvanyaddress
          title: Ip Address
          type: string
        subnet_id:
          description: ID of the subnet that allocated the IP
          example: 351b0dd7-ca09-431c-be53-935db3785067
          examples:
            - 351b0dd7-ca09-431c-be53-935db3785067
          format: uuid4
          title: Subnet Id
          type: string
      required:
        - subnet_id
        - ip_address
      title: PortIpAssignmentSerializer
      type: object
    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
    QuotaScope:
      enum:
        - global
        - regional
      title: QuotaScope
      type: string
  responses:
    ProblemBadRequestOnRead:
      description: >-
        The request cannot succeed as it is. `type` is `validation-error` 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

````