APIs.io Engineering Platform Private API Network API

openapi: 3.0.0
info:
  version: "1.0.0"
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Private API Network API
  description: <fullname>Amazon API Gateway</fullname> <p>Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.</p>
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: apigateway
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
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)
security:
- hmac: []
tags:
- name: Private API Network
  description: The **Private API Network** endpoints enable you to manage and work with your team's [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/). These endpoints are only available on Postman [**Enterprise** plans](https://www.postman.com/pricing/#enterprise-solutions).
paths:
  /network/private:
    get:
      summary: APIs.io Engineering Platform Get all elements and folders
      description: 'Gets information about the folders and their elements added to your [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/).


        **Note:**


        The `limit` and `offset` parameters are separately applied to elements and folders. For example, if you query a `limit` value of `10` and an `offset` value `0`, the endpoint returns 10 elements and 10 folders for a total of 20 items. The `totalCount` property in the `meta` response is the total count of both elements and folders.

        '
      operationId: getAllElementsAndFolders
      x-postman-plan: Enterprise
      tags:
      - Private API Network
      responses:
        '200':
          $ref: '#/components/responses/getPanElementsAndFolders'
        '401':
          $ref: '#/components/responses/common401Error'
        '403':
          $ref: '#/components/responses/common403Error'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
      parameters:
      - $ref: '#/components/parameters/since'
      - $ref: '#/components/parameters/until'
      - $ref: '#/components/parameters/panAddedBy'
      - $ref: '#/components/parameters/panElementName'
      - $ref: '#/components/parameters/panSummary'
      - $ref: '#/components/parameters/panElementDescription'
      - $ref: '#/components/parameters/sortCreatedUpdatedAt'
      - $ref: '#/components/parameters/direction'
      - $ref: '#/components/parameters/createdBy'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/limitDefault1000'
      - $ref: '#/components/parameters/panParentFolderId'
      - $ref: '#/components/parameters/elementTypeQuery'
    post:
      summary: APIs.io Engineering Platform Add an element or folder
      description: 'Publishes a element or creates a folder in your [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/). An element is a Postman API, collection, or workspace.


        **Note:**


        You can only pass one element object type per call. For example, you cannot pass both `api` and `collection` in a single request.

        '
      tags:
      - Private API Network
      operationId: postPanElementOrFolder
      x-postman-plan: Enterprise
      requestBody:
        $ref: '#/components/requestBodies/postPanElementOrFolder'
      responses:
        '201':
          $ref: '#/components/responses/postPanElementOrFolder'
        '401':
          $ref: '#/components/responses/common401Error'
        '403':
          $ref: '#/components/responses/common403Error'
        '404':
          $ref: '#/components/responses/instanceNotFoundElementFolder'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
  /network/private/{elementType}/{elementId}:
    parameters:
    - $ref: '#/components/parameters/elementId'
    - $ref: '#/components/parameters/elementType'
    put:
      summary: APIs.io Engineering Platform Update an element or folder
      description: 'Updates an element or folder in your [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/).


        **Note:**


        You can only pass one element object type per call. For example, you cannot pass both `api` and `collection` in a single request.

        '
      operationId: updatePanElementOrFolder
      x-postman-plan: Enterprise
      tags:
      - Private API Network
      requestBody:
        $ref: '#/components/requestBodies/updatePanElementOrFolder'
      responses:
        '200':
          $ref: '#/components/responses/updatePanElementOrFolder'
        '401':
          $ref: '#/components/responses/common401Error'
        '403':
          $ref: '#/components/responses/common403Error'
        '404':
          $ref: '#/components/responses/instanceNotFoundElementFolder'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
    delete:
      summary: APIs.io Engineering Platform Remove an element or folder
      description: 'Removes an element or delete a folder from your [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/).


        **Note:**


        Removing an API, collection, or workspace element does not delete it. It only removes it from the Private API Network folder.

        '
      tags:
      - Private API Network
      operationId: deletePanElementOrFolder
      x-postman-plan: Enterprise
      responses:
        '200':
          $ref: '#/components/responses/deletePanElementOrFolder'
        '400':
          $ref: '#/components/responses/panFolder400ErrorNotEmpty'
        '401':
          $ref: '#/components/responses/common401Error'
        '403':
          $ref: '#/components/responses/common403Error'
        '404':
          $ref: '#/components/responses/instanceNotFoundElementFolder'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
  /network/private/network-entity/request/all:
    get:
      summary: APIs.io Engineering Platform Get all element add requests
      description: Gets a list requests to add elements to the [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/).
      tags:
      - Private API Network
      operationId: getAllPanAddElementRequests
      x-postman-plan: Enterprise
      responses:
        '200':
          $ref: '#/components/responses/getAllPanAddElementRequests'
        '400':
          $ref: '#/components/responses/pan400ErrorInvalidQueryParams'
        '401':
          $ref: '#/components/responses/common401Error'
        '403':
          $ref: '#/components/responses/common403Error'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
      parameters:
      - $ref: '#/components/parameters/since'
      - $ref: '#/components/parameters/until'
      - $ref: '#/components/parameters/panRequestedBy'
      - $ref: '#/components/parameters/elementTypeQuery'
      - $ref: '#/components/parameters/panRequestStatus'
      - $ref: '#/components/parameters/panElementName'
      - $ref: '#/components/parameters/sortCreatedUpdatedAt'
      - $ref: '#/components/parameters/direction'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/limitDefault1000'
  /network/private/network-entity/request/{requestId}:
    parameters:
    - $ref: '#/components/parameters/panRequestId'
    put:
      summary: APIs.io Engineering Platform Respond to an element add request
      description: Responds to a request to add an element to the [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/). Only managers can approve or deny a request. Once approved, the element will appear in the team's Private API Network.
      tags:
      - Private API Network
      operationId: respondPanElementAddRequest
      x-postman-plan: Enterprise
      requestBody:
        $ref: '#/components/requestBodies/respondPanElementAddRequest'
      responses:
        '200':
          $ref: '#/components/responses/respondPanElementAddRequest'
        '400':
          $ref: '#/components/responses/pan400ErrorInvalidParams'
        '401':
          $ref: '#/components/responses/common401Error'
        '403':
          $ref: '#/components/responses/common403Error'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
components:
  parameters:
    elementTypeQuery:
      name: type
      in: query
      description: Filter by the element type.
      schema:
        type: string
        enum:
        - api
        - folder
        - collection
        - workspace
        example: api
    panRequestId:
      name: requestId
      in: path
      required: true
      description: The element request's ID.
      schema:
        type: integer
        example: 232
    panElementName:
      name: name
      in: query
      description: Return only elements whose name includes the given value. Matching is not case-sensitive.
      schema:
        type: string
        example: billing
    limitDefault1000:
      name: limit
      in: query
      description: The maximum number of elements to return. If the value exceeds the maximum value of `1000`, then the system uses the `1000` value.
      schema:
        type: integer
        default: 1000
        example: 10
    panRequestedBy:
      name: requestedBy
      in: query
      description: Return a user's element requests by their user ID.
      schema:
        type: integer
        example: 12345678
    direction:
      name: direction
      in: query
      description: Sort in ascending (`asc`) or descending (`desc`) order. Matching is not case-sensitive. If you use this query parameter, you must also use the `sort` parameter.
      schema:
        $ref: '#/components/schemas/ascDesc'
    createdBy:
      name: createdBy
      in: query
      description: Return only results created by the given user ID.
      schema:
        type: integer
        example: 12345678
    panElementDescription:
      name: description
      in: query
      description: Return only elements whose description includes the given value. Matching is not case-sensitive.
      schema:
        type: string
        example: payments
    panParentFolderId:
      name: parentFolderId
      in: query
      description: Return the folders and elements in a specific folder. If this value is `0`, then the endpoint only returns the root folder's elements.
      schema:
        type: integer
        example: 1
        default: 0
    panAddedBy:
      name: addedBy
      in: query
      description: Return only elements published by the given user ID.
      schema:
        type: integer
        example: 12345678
    offset:
      name: offset
      in: query
      description: The zero-based offset of the first item to return.
      schema:
        type: integer
        default: 0
        example: 5
    sortCreatedUpdatedAt:
      name: sort
      in: query
      description: Sort the results by the given value. If you use this query parameter, you must also use the `direction` parameter.
      schema:
        type: string
        enum:
        - createdAt
        - updatedAt
        example: updatedAt
    since:
      name: since
      in: query
      description: Return only results created since the given time, in [ISO 8601](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format. This value cannot be later than the `until` value.
      schema:
        $ref: '#/components/schemas/sinceDateTime'
    panRequestStatus:
      name: status
      in: query
      description: Filter by the request status.
      schema:
        type: string
        enum:
        - pending
        - denied
        example: pending
    panSummary:
      name: summary
      in: query
      description: Return only elements whose summary includes the given value. Matching is not case-sensitive.
      schema:
        type: string
        example: payments
    elementType:
      name: elementType
      in: path
      required: true
      description: The element type.
      schema:
        type: string
        enum:
        - api
        - folder
        - collection
        - workspace
        example: api
    elementId:
      name: elementId
      in: path
      required: true
      description: The element's ID or UUID. For Postman Collections you must pass the collection's UID (`userId`-`collectionId`) value.
      schema:
        type: string
        example: 5360b75f-447e-467c-9299-12fd6c92450d
    until:
      name: until
      in: query
      description: Return only results created until this given time, in [ISO 8601](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format. This value cannot be earlier than the `since` value.
      schema:
        $ref: '#/components/schemas/untilDateTime'
  schemas:
    sinceDateTime:
      type: string
      format: date-time
      example: '2022-06-01T00:00:00.000Z'
    pan400ErrorInvalidParams:
      title: Bad Request
      type: object
      properties:
        name:
          type: string
          description: The error name.
          example: invalidParamsError
        message:
          type: string
          description: The error message.
          example: Status type can only be denied or approved.
    updatePanCollection:
      title: Update Collection
      type: object
      properties:
        collection:
          type: object
          properties:
            parentFolderId:
              type: integer
              description: The collection's new parent folder ID.
              example: 1
            environments:
              type: object
              description: The collection's updated environments.
              properties:
                $add:
                  type: array
                  items:
                    type: string
                    description: The ID of environment to add to the collection.
                    example: 92133-622c084d-4f48-470b-826e-18af3c65c775
                $remove:
                  type: array
                  items:
                    type: string
                    description: The ID of environment to remove from the collection.
                    example: 92637-612c7311-4557-470b-826e-18af35682568
    panFolder400ErrorNotEmpty:
      title: Folder Not Empty
      type: object
      properties:
        name:
          type: string
          description: The error name.
          example: instanceNotFoundError
        message:
          type: string
          description: The error message.
          example: You need to empty this folder before deleting it.
    updatePanFolder:
      title: Update Folder
      type: object
      properties:
        folder:
          type: object
          properties:
            name:
              type: string
              description: The folder's new name.
              example: Billing
            description:
              type: string
              description: The folder's updated description.
              example: The Billing API.
            parentFolderId:
              type: integer
              description: The folder's new parent folder ID.
              example: 0
    updatePanApi:
      title: Update API
      type: object
      properties:
        api:
          type: object
          properties:
            parentFolderId:
              type: integer
              description: The API's new parent folder ID.
              example: 1
    panCreateApi:
      title: Add API
      type: object
      properties:
        api:
          type: object
          required:
          - id
          - parentFolderId
          properties:
            id:
              type: string
              description: The API's ID.
              example: 5360b75f-447e-467c-9299-12fd6c92450d
            parentFolderId:
              type: integer
              description: The API's parent folder ID.
              example: 1
    deletePanElementOrFolder:
      title: Successful Response
      type: object
      properties:
        elementType:
          type: object
          description: The Private API Network element type. The name of the object is the element `api`, `collection`, `workspace`, or `folder` type.
          properties:
            id:
              type: string
              description: The element's ID.
              example: 5360b75f-447e-467c-9299-12fd6c92450d
    panCreateCollection:
      title: Add Collection
      type: object
      properties:
        collection:
          type: object
          required:
          - id
          - parentFolderId
          properties:
            id:
              type: string
              description: The collection's ID.
              example: 5360b75f-447e-467c-9299-12fd6c92450d
            parentFolderId:
              type: integer
              description: The collection's parent folder ID.
              example: 1
            environments:
              type: array
              description: A list of environment UIDs (`userId`-`environmentId``) to add to the collection.
              items:
                type: string
                format: uid
                description: An environment's UID.
                example: 12345678-622c084d-4f48-470b-826e-18af3c65c775
    pan400ErrorInvalidQueryParams:
      title: Bad Request
      type: object
      properties:
        name:
          type: string
          description: The error name.
          example: invalidParamsError
        message:
          type: string
          description: The error message.
          example: The specified request does not exist.
    common403Error:
      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: Forbidden
        detail:
          type: string
          description: Information about the error.
          example: Forbidden
        status:
          type: integer
          format: http-status-code
          description: The error's HTTP status code.
          example: 403
    ascDesc:
      type: string
      enum:
      - asc
      - desc
      example: asc
    respondPanElementAddRequestBody:
      type: object
      required:
      - status
      properties:
        response:
          type: object
          description: The response to the user's request.
          properties:
            message:
              type: string
              description: A message that details why the user's request was denied.
              example: The requested collection has a lot of governance violations. Please fix them.
        status:
          type: string
          description: The request's status.
          enum:
          - denied
          - approved
          example: denied
    panCreateWorkspace:
      title: Add Workspace
      type: object
      properties:
        workspace:
          type: object
          required:
          - id
          - parentFolderId
          properties:
            id:
              type: string
              description: The workspace's ID.
              example: 5360b75f-447e-467c-9299-12fd6c92450d
            parentFolderId:
              type: integer
              description: The workspace's parent folder ID.
              example: 1
    untilDateTime:
      type: string
      format: date-time
      example: '2022-06-15T00:00:00.000Z'
    panFolderCreated:
      title: Folder Created
      type: object
      description: Information about the Private API Network folder.
      properties:
        id:
          type: integer
          description: The folder's ID.
          example: 1
        parentFolderId:
          type: integer
          description: The parent folder ID.
          example: 0
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the folder was updated.
          example: '2022-12-07T18:00:39.000Z'
        updatedBy:
          type: integer
          description: The user who updated the folder.
          example: 12345678
        createdBy:
          type: integer
          description: The user who created the folder.
          example: 12345678
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the element was created.
          example: '2022-12-07T18:00:39.000Z'
        name:
          type: string
          description: The folder's name.
          example: Billing
        description:
          type: string
          description: The folder's description.
          example: The Billing API.
        type:
          type: string
          description: The folder's type. This is always the `folder` value.
          example: folder
    updatePanWorkspace:
      title: Update Workspace
      type: object
      properties:
        workspace:
          type: object
          properties:
            parentFolderId:
              type: integer
              description: The workspace's new parent folder ID.
              example: 1
    respondPanElementAddRequestResponse:
      title: Successful Response
      type: object
      properties:
        request:
          type: array
          description: Information about the Private API Network request.
          items:
            type: object
            properties:
              id:
                type: integer
                description: The request's ID.
                example: 2
              createdAt:
                type: string
                format: date-time
                description: The date and time at which the request was created.
                example: '2022-06-09T14:48:45.000Z'
              createdBy:
                type: integer
                description: The ID of the user who created the request.
                example: 12345678
              message:
                type: string
                description: The user's optional message included in the request.
                example: Please add this element to the network
              response:
                description: Information about the response to the element's request. This object only returns when the network manager denied a request with a message.
                type: object
                properties:
                  createdAt:
                    type: string
                    format: date-time
                    description: The date and time at which the network manager denied the request.
                    example: '2020-06-01T08:32:31.000Z'
                  createdBy:
                    type: integer
                    description: The network manager's user ID.
                    example: 87654321
                  message:
                    type: string
                    description: The network manager's request response message.
                    example: Please fix the API issues first
              element:
                description: Information about the requested element.
                type: object
                properties:
                  id:
                    type: string
                    description: The element's ID.
                    example: 5360b75f-447e-467c-9299-12fd3c92450d
                  createdAt:
                    type: string
                    format: date-time
                    description: The date and time at which the element was approved and added to the Private API Network.
                    example: '2022-09-28T13:48:09.000Z'
                  createdBy:
                    type: integer
                    description: The user ID of the user who requested to add the element to the Private API Network.
                    example: 12345678
                  type:
                    type: string
                    description: The element type.
                    enum:
                    - api
                    - workspace
                    - collection
                    example: api
                  name:
                    type: string
                    description: The element's name.
                    example: Test API
                  summary:
                    type: string
                    nullable: true
                    description: If applicable, the element's short summary.
                    example: This is a test API
              status:
                type: string
                description: The request's status.
                enum:
                - approved
                - denied
                example: denied
    instanceNotFoundElementFolder:
      title: Not Found
      type: object
      properties:
        error:
          type: object
          properties:
            name:
              type: string
              description: The error name.
              example: instanceNotFoundError
            message:
              type: string
              description: The error message.
              example: The specified API does not exist.
    getAllPanAddElementRequests:
      title: Successful Response
      type: object
      properties:
        requests:
          description: Information about the requests to add elements to the Private API Network.
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
                description: The request's ID.
                example: 2
              createdAt:
                type: string
                format: date-time
                description: The date and time at which the request was created.
                example: '2022-06-09T14:48:45.000Z'
              createdBy:
                type: integer
                description: The ID of the user who created the request.
                example: 12345678
              message:
                type: string
                description: The user's optional message included in the request.
                example: Please approve this collection
              status:
                type: string
                description: The request's status.
                enum:
                - pending
                - denied
                example: denied
              element:
                type: object
                description: Information about the requested element.
                properties:
                  id:
                    type: string
                    description: The element's ID.
                    example: 5360b75f-447e-467c-9299-12fd3c92450d
                  type:
                    type: string
                    description: The element type.
                    enum:
                    - api
                    - workspace
                    - collection
                    example: collection
                  name:
                    type: string
                    description: The element's name.
                    example: Test Collection
                  summary:
                    type: string
                    nullable: true
                    description: If applicable, the element's short summary.
                    example: null
              response:
                description: Information about the response to the request. This object only returns when the network manager denied a request with a message.
                type: object
                properties:
                  createdAt:
                    type: string
                    format: date-time
                    description: The date and time at which the network manager denied the request.
                    example: '2020-06-01T08:32:31.000Z'
                  createdBy:
                    type: integer
                    description: The network manager's user ID.
                    example: 2272
                  message:
                    type: string
                    description: The network manager's request response message.
                    example: Too many errors, please fix and resubmit
        meta:
          type: object
          description: The response's non-standard meta information.
          properties:
            limit:
              type: integer
              description: The maximum number of items returned.
              example: 10
            offset:
              type: integer
              description: The zero-based offset of the first item returned.
              example: 5
            totalCount:
              type: integer
              description: The total count of items found.
              example: 100
    panCreateFolder:
      title: Add Folder
      type: object
      properties:
        folder:
          type: object
          required:
          - name
          properties:
            name:
              type: string
              description: The folder's name.
              example: Billing
            description:
              type: string
              description: The folder's description.
              example: The Billing API.
            parentFolderId:
              type: integer
              default: 0
              description: The folder's parent folder ID. This value defaults to `0`. To create a folder at the root level, omit this property.
              example: 0
    panElementCreated:
      title: Element Created
      description: Information about the Private API Network element.
      type: object
      properties:
        addedAt:
          type: string
    

# --- truncated at 32 KB (51 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/apis-io-engineering-platform/refs/heads/main/openapi/engineering-platform-private-api-network-api-openapi.yml