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

> Use [GET /v1/projects/{`project_id`}/ports](/api-reference/cloud/ports/list-ports) instead. To find the sub-ports of a trunk, filter by the server with `attached_to_resource_ids` and read `attached_to.trunk`. `ip_address` takes one address. This route is deprecated. Later, we will remove it. We will tell you in advance.

List all ports in the specified project and region.
Results can be filtered by network, subnet, IP address, port ID, attachment,
trunk parent, or `managed_by` value, and sorted by `created_at` or `network_id`.



## OpenAPI

````yaml /api-reference/services_docs_mintlify_enriched/cloud_api.yaml get /cloud/v1/ports/{project_id}/{region_id}
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/ports/{project_id}/{region_id}:
    get:
      tags:
        - Ports
      summary: List ports
      description: >-
        Use [GET
        /v1/projects/{`project_id`}/ports](/api-reference/cloud/ports/list-ports)
        instead. To find the sub-ports of a trunk, filter by the server with
        `attached_to_resource_ids` and read `attached_to.trunk`. `ip_address`
        takes one address. This route is deprecated. Later, we will remove it.
        We will tell you in advance.


        List all ports in the specified project and region.

        Results can be filtered by network, subnet, IP address, port ID,
        attachment,

        trunk parent, or `managed_by` value, and sorted by `created_at` or
        `network_id`.
      operationId: PortListView.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: path
          name: region_id
          required: true
          description: Region ID
          schema:
            description: Region ID
            example: 1
            examples:
              - 1
            title: Region Id
            type: integer
        - in: query
          name: attached
          required: false
          description: Filter attached (true) or standalone (false) ports.
          schema:
            description: Filter attached (true) or standalone (false) ports.
            title: Attached
            type: boolean
        - in: query
          name: ids
          required: false
          description: Filter by port ID(s). Exact match.
          schema:
            description: Filter by port ID(s). Exact match.
            items:
              format: uuid4
              type: string
            title: Ids
            type: array
        - in: query
          name: ip_addresses
          required: false
          description: Filter by IP address(es). Exact match.
          schema:
            description: Filter by IP address(es). Exact match.
            items:
              format: ipvanyaddress
              type: string
            title: Ip Addresses
            type: array
        - in: query
          name: limit
          required: false
          description: Optional. Limit the number of returned items
          schema:
            default: 100
            description: Optional. Limit the number of returned items
            example: 100
            examples:
              - 100
            exclusiveMinimum: 0
            maximum: 1000
            title: Limit
            type: integer
        - in: query
          name: managed_by
          required: false
          description: Filter ports managed by the user or system.
          schema:
            $ref: '#/components/schemas/PortManagedBy'
            description: Filter ports managed by the user or system.
        - in: query
          name: network_ids
          required: false
          description: Filter by network ID(s). Exact match.
          schema:
            description: Filter by network ID(s). Exact match.
            items:
              format: uuid4
              type: string
            title: Network Ids
            type: array
        - in: query
          name: offset
          required: false
          description: >-
            Optional. Offset value is used to exclude the first set of records
            from the result
          schema:
            default: 0
            description: >-
              Optional. Offset value is used to exclude the first set of records
              from the result
            example: 0
            examples:
              - 0
            minimum: 0
            title: Offset
            type: integer
        - in: query
          name: order_by
          required: false
          description: Sort field and direction, e.g. `created_at`.desc or `network_id`.asc
          schema:
            $ref: '#/components/schemas/PortListOrderByChoices'
            default: created_at.desc
            description: >-
              Sort field and direction, e.g. `created_at`.desc or
              `network_id`.asc
        - in: query
          name: parent_port_id
          required: false
          description: Filter trunk sub-ports by their parent port ID.
          schema:
            description: Filter trunk sub-ports by their parent port ID.
            format: uuid4
            title: Parent Port Id
            type: string
        - in: query
          name: resource_id
          required: false
          description: Filter by attached compute resource ID.
          schema:
            description: Filter by attached compute resource ID.
            format: uuid4
            title: Resource Id
            type: string
        - in: query
          name: resource_type
          required: false
          description: Filter by attachment resource type.
          schema:
            $ref: '#/components/schemas/PortResourceType'
            description: Filter by attachment resource type.
        - in: query
          name: subnet_ids
          required: false
          description: Filter by subnet ID(s). Exact match.
          schema:
            description: Filter by subnet ID(s). Exact match.
            items:
              format: uuid4
              type: string
            title: Subnet Ids
            type: array
      responses:
        '200':
          description: Ports
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PortListSerializer'
        '400':
          $ref: '#/components/responses/ProblemBadRequestOnReadWithLegacyKeys'
        '401':
          $ref: '#/components/responses/ProblemUnauthorizedWithLegacyKeys'
        '403':
          $ref: '#/components/responses/ProblemForbiddenWithLegacyKeys'
        '404':
          $ref: '#/components/responses/ProblemNotFoundWithLegacyKeys'
        '409':
          $ref: '#/components/responses/ProblemConflictWithLegacyKeys'
        '500':
          $ref: '#/components/responses/ProblemInternalServerErrorWithLegacyKeys'
        '503':
          $ref: '#/components/responses/ProblemServiceUnavailableWithLegacyKeys'
      deprecated: true
components:
  schemas:
    PortManagedBy:
      enum:
        - system
        - user
      title: PortManagedBy
      type: string
    PortListOrderByChoices:
      enum:
        - created_at.asc
        - created_at.desc
        - network_id.asc
        - network_id.desc
      title: PortListOrderByChoices
      type: string
    PortResourceType:
      enum:
        - baremetal_server
        - basic_vm
        - dhcp
        - gpu_baremetal_server
        - gpu_virtual_server
        - instance
        - load_balancer
        - router
      title: PortResourceType
      type: string
    PortListSerializer:
      properties:
        count:
          description: Number of objects
          example: 1
          examples:
            - 1
          minimum: 0
          title: Count
          type: integer
        results:
          description: Objects
          items:
            $ref: '#/components/schemas/PortDetailSerializer'
          title: Results
          type: array
      required:
        - count
        - results
      title: PortListSerializer
      type: object
    PortDetailSerializer:
      properties:
        allowed_address_pairs:
          description: >-
            List of allowed address pairs. Sorted by `ip_address` for stable
            client refreshes.
          items:
            $ref: '#/components/schemas/AllowedAddressPairsResponseSerializer'
          title: Allowed Address Pairs
          type: array
        attached_to:
          anyOf:
            - $ref: '#/components/schemas/PortAttachmentSerializer'
            - type: 'null'
          description: >-
            The compute resource this port is attached to, including trunk role
            for trunk parents and sub-ports. null when the port is standalone
            (unattached).
        capabilities:
          anyOf:
            - $ref: '#/components/schemas/PortCapabilitiesSerializer'
            - type: 'null'
          description: >-
            What the driver enforces. null when the port is unattached (driver
            unknown).
        created_at:
          description: Datetime when the port was created.
          example: '2024-01-15T10:30:00Z'
          examples:
            - '2024-01-15T10:30:00Z'
          format: date-time
          title: Created At
          type: string
        id:
          description: Port ID
          example: 1f0ca628-a73b-42c0-bdac-7b10d023e097
          examples:
            - 1f0ca628-a73b-42c0-bdac-7b10d023e097
          format: uuid4
          title: Id
          type: string
        ip_assignments:
          description: List of IP addresses assigned to the port.
          items:
            $ref: '#/components/schemas/IpAssignmentSerializer'
          title: Ip Assignments
          type: array
        mac_address:
          description: MAC address of the port
          example: fa:16:3e:f2:87:16
          examples:
            - fa:16:3e:f2:87:16
          title: Mac Address
          type: string
        managed_by:
          $ref: '#/components/schemas/PortManagedBy'
          description: >-
            Who manages this port: 'user' (full CRUD allowed) or 'system'
            (read-only)
          examples:
            - user
        network_id:
          description: ID of the network the port belongs to
          example: bc688791-f1b0-44eb-97d4-07697294b1e1
          examples:
            - bc688791-f1b0-44eb-97d4-07697294b1e1
          format: uuid4
          title: Network Id
          type: string
        port_security_enabled:
          description: >-
            When true, the driver enforces port security on this port
            (anti-spoofing checks and security-group filtering apply). When
            false, all traffic is allowed and security groups are not applied.
          example: true
          examples:
            - true
          title: Port Security Enabled
          type: boolean
        security_group_ids:
          description: >-
            List of security group IDs applied to the port. Sorted
            lexicographically for stable client refreshes.
          example:
            - bc688791-f1b0-44eb-97d4-07697294b1e1
          examples:
            - - bc688791-f1b0-44eb-97d4-07697294b1e1
          items:
            format: uuid4
            type: string
          title: Security Group Ids
          type: array
        system_tags:
          additionalProperties:
            type: string
          description: >-
            Read-only key-value tags on the port, set by the platform and not
            modifiable by the user
          example:
            image_name: ubuntu-22.04
            os_type: linux
          examples:
            - image_name: ubuntu-22.04
              os_type: linux
          title: System Tags
          type: object
        tags:
          additionalProperties:
            type: string
          description: Key-value tags on the port
          example:
            env: prod
            team: platform
          examples:
            - env: prod
              team: platform
          title: Tags
          type: object
        updated_at:
          description: Datetime when the port was last updated.
          example: '2025-11-18T10:22:00Z'
          examples:
            - '2025-11-18T10:22:00Z'
          format: date-time
          title: Updated At
          type: string
      required:
        - id
        - mac_address
        - network_id
        - ip_assignments
        - port_security_enabled
        - security_group_ids
        - allowed_address_pairs
        - tags
        - system_tags
        - managed_by
        - capabilities
        - attached_to
        - created_at
        - updated_at
      title: PortDetailSerializer
      type: object
    ProblemWithLegacyKeys:
      additionalProperties: false
      description: >-
        The error body of an endpoint that was released before the problem body.
        The old keys stay

        next to the problem fields until the endpoint is removed.
      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
        exception_class:
          deprecated: true
          description: The old name of the error. Use `type`.
          title: Exception Class
          type: string
        hint:
          description: What to do next.
          title: Hint
          type: string
        info:
          default: null
          deprecated: true
          description: Old data about the error. Use `context`.
          title: Info
        invalid_fields:
          default: null
          deprecated: true
          description: The old list of the invalid inputs. Use `errors`.
          title: Invalid Fields
        message:
          deprecated: true
          description: The old text of the error. Use `detail`.
          title: Message
          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
        - exception_class
        - message
      title: ProblemWithLegacyKeys
      type: object
    AllowedAddressPairsResponseSerializer:
      properties:
        ip_address:
          anyOf:
            - format: ipvanyaddress
              type: string
            - format: ipvanynetwork
              type: string
          description: Subnet mask or IP address of the allowed address pair
          examples:
            - 192.168.123.20
          title: Ip Address
      required:
        - ip_address
      title: AllowedAddressPairsResponseSerializer
      type: object
    PortAttachmentSerializer:
      properties:
        resource_id:
          anyOf:
            - format: uuid4
              type: string
            - type: 'null'
          description: >-
            ID of the compute resource the port is attached to. null for DHCP
            attachments.
          examples:
            - a1b2c3d4-e5f6-4000-8000-000000000001
          title: Resource Id
        resource_type:
          anyOf:
            - $ref: '#/components/schemas/PortResourceType'
            - type: 'null'
          description: >-
            Type of resource the port is attached to. null when the compute
            resource's type is not yet known.
          examples:
            - instance
        trunk:
          anyOf:
            - discriminator:
                mapping:
                  parent: '#/components/schemas/PortAttachmentTrunkParentSerializer'
                  sub_port: '#/components/schemas/PortAttachmentTrunkSubPortSerializer'
                propertyName: role
              oneOf:
                - $ref: '#/components/schemas/PortAttachmentTrunkParentSerializer'
                - $ref: '#/components/schemas/PortAttachmentTrunkSubPortSerializer'
            - type: 'null'
          description: >-
            Trunk info: present when port is a trunk parent or `sub_port`. null
            otherwise.
          title: Trunk
      required:
        - resource_id
        - resource_type
        - trunk
      title: PortAttachmentSerializer
      type: object
    PortCapabilitiesSerializer:
      properties:
        allowed_address_pairs:
          description: Whether the driver enforces allowed address pairs on this port
          title: Allowed Address Pairs
          type: boolean
        port_security:
          description: Whether the driver enforces port security on this port
          title: Port Security
          type: boolean
        security_groups:
          description: Whether the driver enforces security groups on this port
          title: Security Groups
          type: boolean
      required:
        - security_groups
        - port_security
        - allowed_address_pairs
      title: PortCapabilitiesSerializer
      type: object
    IpAssignmentSerializer:
      properties:
        ip_address:
          anyOf:
            - format: ipv4
              type: string
            - format: ipv6
              type: string
          description: IP address assigned to the port
          examples:
            - 192.168.123.20
          title: Ip Address
        subnet_id:
          description: ID of the subnet
          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: IpAssignmentSerializer
      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
    PortAttachmentTrunkParentSerializer:
      properties:
        role:
          const: parent
          description: Trunk role. 'parent' means this port is a trunk parent.
          example: parent
          examples:
            - parent
          title: Role
          type: string
      required:
        - role
      title: PortAttachmentTrunkParentSerializer
      type: object
    PortAttachmentTrunkSubPortSerializer:
      properties:
        parent_port_id:
          description: ID of the trunk parent port this sub-port belongs to.
          example: bc688791-f1b0-44eb-97d4-07697294b1e1
          examples:
            - bc688791-f1b0-44eb-97d4-07697294b1e1
          format: uuid4
          title: Parent Port Id
          type: string
        role:
          const: sub_port
          description: Trunk role. 'sub_port' means this port is a sub-port of a trunk.
          example: sub_port
          examples:
            - sub_port
          title: Role
          type: string
      required:
        - role
        - parent_port_id
      title: PortAttachmentTrunkSubPortSerializer
      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:
    ProblemBadRequestOnReadWithLegacyKeys:
      description: >-
        The request cannot succeed as it is. `type` is `validation-error` or
        `not-available`.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemWithLegacyKeys'
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
        Content-Language:
          $ref: '#/components/headers/ContentLanguage'
    ProblemUnauthorizedWithLegacyKeys:
      description: The request has no valid credentials. `type` is `unauthorized`.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemWithLegacyKeys'
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
        Content-Language:
          $ref: '#/components/headers/ContentLanguage'
    ProblemForbiddenWithLegacyKeys:
      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/ProblemWithLegacyKeys'
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
        Content-Language:
          $ref: '#/components/headers/ContentLanguage'
    ProblemNotFoundWithLegacyKeys:
      description: The resource or the URL does not exist. `type` is `not-found`.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemWithLegacyKeys'
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
        Content-Language:
          $ref: '#/components/headers/ContentLanguage'
    ProblemConflictWithLegacyKeys:
      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/ProblemWithLegacyKeys'
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
        Content-Language:
          $ref: '#/components/headers/ContentLanguage'
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
    ProblemInternalServerErrorWithLegacyKeys:
      description: >-
        The server cannot complete the request. `type` is
        `internal-server-error`.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemWithLegacyKeys'
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
        Content-Language:
          $ref: '#/components/headers/ContentLanguage'
    ProblemServiceUnavailableWithLegacyKeys:
      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/ProblemWithLegacyKeys'
      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

````