APIs.io Engineering Platform Tags API

openapi: 3.2.0
info:
  title: Engineering Platform Tags API
  x-refined-note:
  - x-apiClientRegistration differs across the merged source definitions and was not carried
  - x-apisguru-categories differs across the merged source definitions and was not carried
  - x-logo differs across the merged source definitions and was not carried
  - x-origin differs across the merged source definitions and was not carried
  - x-preferred differs across the merged source definitions and was not carried
  - x-providerName differs across the merged source definitions and was not carried
  - x-release differs across the merged source definitions and was not carried
  - x-serviceName differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged Tags across 2 of this provider''s published API definitions: aws-api-gateway-openapi-original.yml, postman-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: http://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: https://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: http://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
- url: https://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
- url: https://api.getpostman.com
- url: https://api.eu.postman.com
tags:
- name: Tags
paths:
  /tags/{resource_arn}:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    get:
      operationId: GetTags
      description: Gets the Tags collection for a given resource.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tags'
        '480':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '481':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '482':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
        '483':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      parameters:
      - name: resource_arn
        in: path
        required: true
        description: The ARN of a resource that can be tagged.
        schema:
          type: string
      - name: position
        in: query
        required: false
        description: (Not currently supported) The current pagination position in the paged result set.
        schema:
          type: string
      - name: limit
        in: query
        required: false
        description: (Not currently supported) The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
        schema:
          type: integer
      tags:
      - Tags
      security:
      - hmac: []
    put:
      operationId: TagResource
      description: Adds or updates a tag on a given resource.
      responses:
        '204':
          description: Success
        '480':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '481':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '482':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '483':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '484':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
        '485':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      parameters:
      - name: resource_arn
        in: path
        required: true
        description: The ARN of a resource that can be tagged.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - tags
              properties:
                tags:
                  description: The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters.
                  type: object
                  additionalProperties:
                    $ref: '#/components/schemas/String'
      tags:
      - Tags
      security:
      - hmac: []
    servers:
    - url: http://apigateway.{region}.amazonaws.com
      variables:
        region:
          description: The AWS region
          enum:
          - us-east-1
          - us-east-2
          - us-west-1
          - us-west-2
          - us-gov-west-1
          - us-gov-east-1
          - ca-central-1
          - eu-north-1
          - eu-west-1
          - eu-west-2
          - eu-west-3
          - eu-central-1
          - eu-south-1
          - af-south-1
          - ap-northeast-1
          - ap-northeast-2
          - ap-northeast-3
          - ap-southeast-1
          - ap-southeast-2
          - ap-east-1
          - ap-south-1
          - sa-east-1
          - me-south-1
          default: us-east-1
      description: The Amazon API Gateway multi-region endpoint
    - url: https://apigateway.{region}.amazonaws.com
      variables:
        region:
          description: The AWS region
          enum:
          - us-east-1
          - us-east-2
          - us-west-1
          - us-west-2
          - us-gov-west-1
          - us-gov-east-1
          - ca-central-1
          - eu-north-1
          - eu-west-1
          - eu-west-2
          - eu-west-3
          - eu-central-1
          - eu-south-1
          - af-south-1
          - ap-northeast-1
          - ap-northeast-2
          - ap-northeast-3
          - ap-southeast-1
          - ap-southeast-2
          - ap-east-1
          - ap-south-1
          - sa-east-1
          - me-south-1
          default: us-east-1
      description: The Amazon API Gateway multi-region endpoint
    - url: http://apigateway.{region}.amazonaws.com.cn
      variables:
        region:
          description: The AWS region
          enum:
          - cn-north-1
          - cn-northwest-1
          default: cn-north-1
      description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
    - url: https://apigateway.{region}.amazonaws.com.cn
      variables:
        region:
          description: The AWS region
          enum:
          - cn-north-1
          - cn-northwest-1
          default: cn-north-1
      description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
  /tags/{resource_arn}#tagKeys:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    delete:
      operationId: UntagResource
      description: Removes a tag from a given resource.
      responses:
        '204':
          description: Success
        '480':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '481':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '482':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '483':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '484':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
        '485':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      parameters:
      - name: resource_arn
        in: path
        required: true
        description: The ARN of a resource that can be tagged.
        schema:
          type: string
      - name: tagKeys
        in: query
        required: true
        description: The Tag keys to delete.
        schema:
          type: array
          items:
            $ref: '#/components/schemas/String'
      tags:
      - Tags
      security:
      - hmac: []
    servers:
    - url: http://apigateway.{region}.amazonaws.com
      variables:
        region:
          description: The AWS region
          enum:
          - us-east-1
          - us-east-2
          - us-west-1
          - us-west-2
          - us-gov-west-1
          - us-gov-east-1
          - ca-central-1
          - eu-north-1
          - eu-west-1
          - eu-west-2
          - eu-west-3
          - eu-central-1
          - eu-south-1
          - af-south-1
          - ap-northeast-1
          - ap-northeast-2
          - ap-northeast-3
          - ap-southeast-1
          - ap-southeast-2
          - ap-east-1
          - ap-south-1
          - sa-east-1
          - me-south-1
          default: us-east-1
      description: The Amazon API Gateway multi-region endpoint
    - url: https://apigateway.{region}.amazonaws.com
      variables:
        region:
          description: The AWS region
          enum:
          - us-east-1
          - us-east-2
          - us-west-1
          - us-west-2
          - us-gov-west-1
          - us-gov-east-1
          - ca-central-1
          - eu-north-1
          - eu-west-1
          - eu-west-2
          - eu-west-3
          - eu-central-1
          - eu-south-1
          - af-south-1
          - ap-northeast-1
          - ap-northeast-2
          - ap-northeast-3
          - ap-southeast-1
          - ap-southeast-2
          - ap-east-1
          - ap-south-1
          - sa-east-1
          - me-south-1
          default: us-east-1
      description: The Amazon API Gateway multi-region endpoint
    - url: http://apigateway.{region}.amazonaws.com.cn
      variables:
        region:
          description: The AWS region
          enum:
          - cn-north-1
          - cn-northwest-1
          default: cn-north-1
      description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
    - url: https://apigateway.{region}.amazonaws.com.cn
      variables:
        region:
          description: The AWS region
          enum:
          - cn-north-1
          - cn-northwest-1
          default: cn-north-1
      description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
  /tags/{slug}/entities:
    get:
      summary: APIs.io Engineering Platform Get elements by tag
      description: 'Gets Postman elements (entities) by a given tag. Tags enable you to organize and search [workspaces](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/#tagging-a-workspace), [APIs](https://learning.postman.com/docs/designing-and-developing-your-api/managing-apis/#tagging-apis), and [collections](https://learning.postman.com/docs/collections/using-collections/#tagging-a-collection) that contain shared tags.


        **Note:**


        Tagging is available on Postman [**Enterprise** plans](https://www.postman.com/pricing/).

        '
      operationId: getTaggedEntities
      x-postman-plan: Enterprise
      tags:
      - Tags
      responses:
        '200':
          $ref: '#/components/responses/getTaggedEntities'
        '400':
          $ref: '#/components/responses/tagElement400Error'
        '401':
          $ref: '#/components/responses/tag401Error'
        '403':
          $ref: '#/components/responses/tag403Error'
        '404':
          $ref: '#/components/responses/tag404Error'
        '500':
          $ref: '#/components/responses/tag500Error'
      parameters:
      - $ref: '#/components/parameters/tagsSlug'
      - $ref: '#/components/parameters/tagsEntitiesLimit'
      - $ref: '#/components/parameters/tagsEntitiesDirection'
      - $ref: '#/components/parameters/tagsCursor'
      - $ref: '#/components/parameters/tagsEntityType'
      security:
      - PostmanApiKey: []
      - scimApiKey: []
    servers:
    - url: https://api.getpostman.com
    - url: https://api.eu.postman.com
components:
  schemas:
    ConflictException: {}
    TooManyRequestsException: {}
    UnauthorizedException: {}
    String:
      type: string
    NotFoundException: {}
    MapOfStringToString:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/String'
    Tags:
      type: object
      properties:
        tags:
          allOf:
          - $ref: '#/components/schemas/MapOfStringToString'
          - description: The collection of tags. Each tag element is associated with a given resource.
      description: The collection of tags. Each tag element is associated with a given resource.
    LimitExceededException: {}
    BadRequestException: {}
    tag404Error:
      title: Not Found
      type: object
      properties:
        type:
          type: string
          format: uri-reference
          description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem.
          example: https://api.postman.com/problems/not-found
        title:
          type: string
          description: A short summary of the problem.
          example: Resource Not Found
        detail:
          type: string
          description: Information about the error.
          example: Slug 'needs-review' does not exist.
        status:
          type: integer
          format: http-status-code
          description: The error's HTTP status code.
          example: 404
        instance:
          type: string
          description: The URI reference that identifies the specific occurrence of the problem.
          example: /tags/needs-review/entities
    tagElement400Error:
      title: Bad Request
      type: object
      properties:
        error:
          type: string
          description: A short summary of the problem.
          example: Bad Request
        message:
          type: string
          description: The error message.
          example: params/slug must match pattern \"^[a-z][a-z0-9-]*[a-z0-9]+$\"
        statusCode:
          type: integer
          format: http-status-code
          description: The error's HTTP status code.
          example: 400
    tag401Error:
      title: Unauthorized
      type: object
      properties:
        type:
          type: string
          format: uri-reference
          description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem.
          example: https://api.postman.com/problems/unauthorized
        title:
          type: string
          description: A short summary of the problem.
          example: Unauthorized
        detail:
          type: string
          description: Information about the error.
          example: The request lacks valid credentials.
        status:
          type: integer
          format: http-status-code
          description: The error's HTTP status code.
          example: 401
    ascDescDefaultDesc:
      type: string
      default: desc
      enum:
      - asc
      - desc
      example: desc
    getTaggedEntities:
      title: Successful Response
      type: object
      properties:
        data:
          type: object
          description: An object containing the paginated elements.
          required:
          - entities
          properties:
            entities:
              type: array
              description: A list of the Postman elements that contain the given tag.
              items:
                type: object
                properties:
                  entityId:
                    type: string
                    format: uid
                    description: The element's unique ID.
                    example: 12345678-6fd634a3-79ba-451d-8f07-56a953f96667
                  entityType:
                    enum:
                    - api
                    - collection
                    - workspace
                    type: string
                    description: The type of Postman element.
                    example: collection
        meta:
          type: object
          description: The response's pagination information.
          required:
          - count
          properties:
            count:
              type: integer
              description: The number of tagged elements returned in the response.
              example: 2
            nextCursor:
              type: string
              format: base64
              description: The pagination cursor that points to the next record in the results set.
              example: eyJpZCI6ODYsImVudGl0eVR5cGUiOiJhcGkifQ==
    tag500Error:
      title: Unexpected Error
      type: object
      properties:
        type:
          type: string
          format: uri-reference
          description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem.
          example: https://api.postman.com/problems/internal-server-error
        title:
          type: string
          description: A short summary of the problem.
          example: Something went wrong
        detail:
          type: string
          description: Information about the error.
          example: Something went wrong while fetching entities having the provided slug.
        status:
          type: integer
          format: http-status-code
          description: The error's HTTP status code.
          example: 500
        instance:
          type: string
          example: /tags/hello-world/entities
          description: The URI reference that identifies the specific occurrence of the problem.
    tag403Error:
      title: Forbidden
      type: object
      properties:
        type:
          type: string
          format: uri-reference
          description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem.
          example: https://api.postman.com/problems/forbidden
        title:
          type: string
          description: A short summary of the problem.
          example: Access Denied
        detail:
          type: string
          description: Information about the error.
          example: The tags feature is only available to enterprise teams
        status:
          type: integer
          format: http-status-code
          description: The error's HTTP status code.
          example: 403
  parameters:
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    tagsEntitiesDirection:
      name: direction
      in: query
      description: The ascending (`asc`) or descending (`desc`) order to sort the results by, based on the time of the entity's tagging.
      schema:
        $ref: '#/components/schemas/ascDescDefaultDesc'
    tagsSlug:
      name: slug
      in: path
      required: true
      description: The tag's ID within a team or individual (non-team) user scope.
      schema:
        type: string
        pattern: ^[a-z][a-z0-9-]*[a-z0-9]+$
        maxLength: 64
        minLength: 2
        example: needs-review
    tagsEntitiesLimit:
      name: limit
      in: query
      description: The maximum number of tagged elements to return in a single call.
      schema:
        type: integer
        default: 10
        maximum: 50
        example: 2
    tagsEntityType:
      name: entityType
      in: query
      description: Filter results for the given entity type.
      schema:
        type: string
        enum:
        - api
        - collection
        - workspace
        example: collection
    tagsCursor:
      name: cursor
      in: query
      description: The cursor to get the next set of results in the paginated response. If you pass an invalid value, the API only returns the first set of results.
      schema:
        type: string
        format: base64
        example: eyJpZCI6ODYsImVudGl0eVR5cGUiOiJhcGkifQ==
  responses:
    tag404Error:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/tag404Error'
          example:
            type: https://api.postman.com/problems/not-found
            title: Resource Not Found
            detail: Slug 'needs-review' does not exist.
            status: 404
            instance: /tags/needs-review/entities
    tag403Error:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/tag403Error'
          example:
            type: https://api.postman.com/problems/forbidden
            title: Access Denied
            detail: The tags feature is only available to enterprise teams
            status: 403
    tag500Error:
      description: Unexpected Error
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/tag500Error'
          example:
            type: https://api.postman.com/problems/internal-server-error
            title: Something went wrong
            detail: Something went wrong while fetching entities having the provided slug.
            status: 500
            instance: /tags/needs-review/entities
    getTaggedEntities:
      description: Successful Response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/getTaggedEntities'
          example:
            data:
              entities:
              - entityId: 8b86dfe8-de72-44e6-81ea-79d19805bc6a
                entityType: api
            meta:
              count: 1
    tag401Error:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/tag401Error'
          example:
            type: https://api.postman.com/problems/unauthorized
            title: Unauthorized
            detail: The request lacks valid credentials.
            status: 401
    tagElement400Error:
      description: Bad Request
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/tagElement400Error'
          example:
            error: Bad Request
            message: params/slug must match pattern \"^[a-z][a-z0-9-]*[a-z0-9]+$\"
            statusCode: 400
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
    PostmanApiKey:
      type: apiKey
      in: header
      name: x-api-key
    scimApiKey:
      type: apiKey
      in: header
      name: Authorization
      description: A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/apigateway/
x-refined-from:
- aws-api-gateway-openapi-original.yml
- postman-openapi-original.yml
x-hasEquivalentPaths: true