APIs.io Engineering Platform User API Tokens API

openapi: 3.2.0
info:
  description: 'To get started using Cloudflare''s products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources.


    Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions.


    To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to

    our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/).


    Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/).'
  license:
    name: BSD-3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
  title: APIs.io Engineering Platform Cloudflare User API Tokens API
  version: 4.0.0
tags:
- name: User API Tokens
paths:
  /user/tokens:
    get:
      description: List all access tokens you created.
      operationId: user-api-tokens-list-tokens
      parameters:
      - in: query
        name: page
        schema:
          default: 1
          description: Page number of paginated results.
          minimum: 1
          type: number
      - in: query
        name: per_page
        schema:
          default: 20
          description: Maximum number of results per page.
          maximum: 50
          minimum: 5
          type: number
      - in: query
        name: direction
        schema:
          description: Direction to order results.
          enum:
          - asc
          - desc
          example: desc
          type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: List Tokens response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_collection_tokens_response'
          description: List Tokens response
      security:
      - api_token: []
      summary: APIs.io Engineering Platform List Tokens
      tags:
      - User API Tokens
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.token.list
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    post:
      description: Create a new access token.
      operationId: user-api-tokens-create-token
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/iam_create_payload'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Create Token response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_single_token_create_response'
          description: Create Token response
      security:
      - api_token: []
      summary: APIs.io Engineering Platform Create Token
      tags:
      - User API Tokens
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.token.create
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /user/tokens/{token_id}:
    delete:
      description: Destroy a token.
      operationId: user-api-tokens-delete-token
      parameters:
      - in: path
        name: token_id
        required: true
        schema:
          $ref: '#/components/schemas/iam_token_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Delete Token response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-single-id'
          description: Delete Token response
      security:
      - api_token: []
      summary: APIs.io Engineering Platform Delete Token
      tags:
      - User API Tokens
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.token.delete
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    get:
      description: Get information about a specific token.
      operationId: user-api-tokens-token-details
      parameters:
      - in: path
        name: token_id
        required: true
        schema:
          $ref: '#/components/schemas/iam_token_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Token Details response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_single_token_response'
          description: Token Details response
      security:
      - api_token: []
      summary: APIs.io Engineering Platform Token Details
      tags:
      - User API Tokens
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.token.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    put:
      description: Update an existing token.
      operationId: user-api-tokens-update-token
      parameters:
      - in: path
        name: token_id
        required: true
        schema:
          $ref: '#/components/schemas/iam_token_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/iam_token_body'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Update Token response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_single_token_response'
          description: Update Token response
      security:
      - api_token: []
      summary: APIs.io Engineering Platform Update Token
      tags:
      - User API Tokens
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.token.update
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /user/tokens/{token_id}/value:
    put:
      description: Roll the token secret.
      operationId: user-api-tokens-roll-token
      parameters:
      - in: path
        name: token_id
        required: true
        schema:
          $ref: '#/components/schemas/iam_token_identifier'
      requestBody:
        content:
          application/json:
            schema:
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Roll Token response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_response_single_value'
          description: Roll Token response
      security:
      - api_token: []
      summary: APIs.io Engineering Platform Roll Token
      tags:
      - User API Tokens
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.token.update
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /user/tokens/verify:
    get:
      description: Test whether a token works.
      operationId: user-api-tokens-verify-token
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Verify Token response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_response_single_segment'
          description: Verify Token response
      security:
      - api_token: []
      summary: APIs.io Engineering Platform Verify Token
      tags:
      - User API Tokens
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
components:
  schemas:
    iam_common_components-schemas-identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    iam_token_base:
      properties:
        condition:
          $ref: '#/components/schemas/iam_condition'
        expires_on:
          $ref: '#/components/schemas/iam_expires_on'
        id:
          $ref: '#/components/schemas/iam_token_identifier'
        issued_on:
          $ref: '#/components/schemas/iam_issued_on'
        last_used_on:
          $ref: '#/components/schemas/iam_last_used_on'
        modified_on:
          $ref: '#/components/schemas/iam_modified_on'
        name:
          $ref: '#/components/schemas/iam_name'
        not_before:
          $ref: '#/components/schemas/iam_not_before'
        policies:
          $ref: '#/components/schemas/iam_token_policies'
        status:
          $ref: '#/components/schemas/iam_status'
      type: object
    iam_name:
      description: Token name.
      example: readonly token
      maxLength: 120
      type: string
    iam_create_payload:
      properties:
        condition:
          $ref: '#/components/schemas/iam_condition'
        expires_on:
          $ref: '#/components/schemas/iam_expires_on'
        name:
          $ref: '#/components/schemas/iam_name'
        not_before:
          $ref: '#/components/schemas/iam_not_before'
        policies:
          $ref: '#/components/schemas/iam_token_policies'
      required:
      - name
      - policies
      type: object
    iam_identifier:
      description: Policy identifier.
      example: f267e341f3dd4697bd3b9f71dd96247f
      readOnly: true
      type: string
    iam_last_used_on:
      description: Last time the token was used.
      example: '2020-01-02T12:34:00Z'
      format: date-time
      readOnly: true
      type: string
    iam_status:
      description: Status of the token.
      enum:
      - active
      - disabled
      - expired
      example: active
      type: string
    iam_collection_tokens_response:
      allOf:
      - $ref: '#/components/schemas/iam_api-response-collection'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/iam_token_base'
            type: array
        type: object
      title: Response with a list of tokens
    iam_permission_group:
      description: A named group of permissions that map to a group of operations against resources.
      properties:
        id:
          description: Identifier of the group.
          example: 6d7f2f5f5b1d4a0e9081fdc98d432fd1
          readOnly: true
          type: string
        meta:
          description: Attributes associated to the permission group.
          example:
            label: load_balancer_admin
            scopes: com.cloudflare.api.account
          properties:
            key:
              type: string
            value:
              type: string
          type: object
        name:
          description: Name of the group.
          example: Load Balancer
          readOnly: true
          type: string
      required:
      - id
      type: object
    iam_cidr_list:
      description: List of IPv4/IPv6 CIDR addresses.
      example:
      - 199.27.128.0/21
      - 2400:cb00::/32
      items:
        description: IPv4/IPv6 CIDR.
        example: 199.27.128.0/21
        type: string
      type: array
    iam_policy_with_permission_groups_and_resources:
      properties:
        effect:
          $ref: '#/components/schemas/iam_effect'
        id:
          $ref: '#/components/schemas/iam_identifier'
        permission_groups:
          $ref: '#/components/schemas/iam_permission_groups'
        resources:
          $ref: '#/components/schemas/iam_resources'
      required:
      - id
      - effect
      - permission_groups
      - resources
      title: Policy with Permission Groups and Resources
      type: object
    iam_token_body:
      allOf:
      - $ref: '#/components/schemas/iam_token_base'
      - type: object
      - required:
        - name
        - status
        - policies
      title: Token defined in a request body
    iam_request_ip:
      description: Client IP restrictions.
      example:
        in:
        - 123.123.123.0/24
        - 2606:4700::/32
        not_in:
        - 123.123.123.100/24
        - 2606:4700:4700::/48
      properties:
        in:
          $ref: '#/components/schemas/iam_cidr_list'
        not_in:
          $ref: '#/components/schemas/iam_cidr_list'
      type: object
    iam_response_single_segment:
      allOf:
      - $ref: '#/components/schemas/iam_api-response-single'
      - properties:
          result:
            properties:
              expires_on:
                $ref: '#/components/schemas/iam_expires_on'
              id:
                $ref: '#/components/schemas/iam_token_identifier'
              not_before:
                $ref: '#/components/schemas/iam_not_before'
              status:
                $ref: '#/components/schemas/iam_status'
            required:
            - id
            - status
        type: object
    iam_api-response-single-id:
      allOf:
      - $ref: '#/components/schemas/iam_api-response-common'
      - properties:
          result:
            properties:
              id:
                $ref: '#/components/schemas/iam_common_components-schemas-identifier'
            required:
            - id
            type:
            - object
            - 'null'
      type: object
    iam_single_token_create_response:
      allOf:
      - $ref: '#/components/schemas/iam_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/iam_token_with_value'
        type: object
      title: Response of a create request with a single token
    iam_token_with_value:
      allOf:
      - $ref: '#/components/schemas/iam_token_base'
      - properties:
          value:
            $ref: '#/components/schemas/iam_value'
      title: Create token response, with the token value
    iam_not_before:
      description: The time before which the token MUST NOT be accepted for processing.
      example: '2018-07-01T05:20:00Z'
      format: date-time
      type: string
    iam_resources:
      description: A list of resource names that the policy applies to.
      example:
        com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43: '*'
        com.cloudflare.api.account.zone.eb78d65290b24279ba6f44721b3ea3c4: '*'
      properties:
        resource:
          type: string
        scope:
          type: string
      type: object
    iam_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/iam_messages'
        messages:
          $ref: '#/components/schemas/iam_messages'
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      type: object
    iam_response_single_value:
      allOf:
      - $ref: '#/components/schemas/iam_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/iam_value'
        type: object
    iam_value:
      description: The token value.
      example: 8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T
      maxLength: 80
      minLength: 40
      readOnly: true
      type: string
      x-sensitive: true
    iam_token_identifier:
      description: Token identifier tag.
      example: ed17574386854bf78a67040be0a770b0
      maxLength: 32
      readOnly: true
      type: string
    iam_token_policies:
      description: List of access policies assigned to the token.
      items:
        $ref: '#/components/schemas/iam_policy_with_permission_groups_and_resources'
      type: array
    iam_single_token_response:
      allOf:
      - $ref: '#/components/schemas/iam_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/iam_token_base'
        type: object
      title: Response with a single token
    iam_permission_groups:
      description: A set of permission groups that are specified to the policy.
      example:
      - id: c8fed203ed3043cba015a93ad1616f1f
        meta:
          label: load_balancer_admin
          scopes: com.cloudflare.api.account
        name: Zone Read
      - id: 82e64a83756745bbbb1c9c2701bf816b
        meta:
          label: fbm_user
          scopes: com.cloudflare.api.account
        name: Magic Network Monitoring
      items:
        $ref: '#/components/schemas/iam_permission_group'
      type: array
    iam_condition:
      properties:
        request.ip:
          $ref: '#/components/schemas/iam_request_ip'
      type: object
    iam_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    iam_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/iam_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/iam_messages'
          example: []
        result:
          enum:
          - null
          type:
          - object
          - 'null'
        success:
          description: Whether the API call was successful
          enum:
          - false
          example: false
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    iam_expires_on:
      description: The expiration time on or after which the JWT MUST NOT be accepted for processing.
      example: '2020-01-01T00:00:00Z'
      format: date-time
      type: string
    iam_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/iam_api-response-common'
      - properties:
          result:
            items: {}
            type:
            - array
            - 'null'
          result_info:
            $ref: '#/components/schemas/iam_result_info'
      type: object
    iam_issued_on:
      description: The time on which the token was created.
      example: '2018-07-01T05:20:00Z'
      format: date-time
      readOnly: true
      type: string
    iam_effect:
      description: Allow or deny operations against the resources.
      enum:
      - allow
      - deny
      example: allow
      type: string
    iam_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    iam_modified_on:
      description: Last time the token was modified.
      example: '2018-07-02T05:20:00Z'
      format: date-time
      readOnly: true
      type: string
    iam_api-response-single:
      allOf:
      - $ref: '#/components/schemas/iam_api-response-common'
      type: object
  securitySchemes:
    api_email:
      in: header
      name: X-Auth-Email
      type: apiKey
    api_key:
      in: header
      name: X-Auth-Key
      type: apiKey
    api_token:
      scheme: bearer
      type: http
    user_service_key:
      in: header
      name: X-Auth-User-Service-Key
      type: apiKey