APIs.io Engineering Platform Infrastructure Access Targets 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 Infrastructure Access Targets API
  version: 4.0.0
tags:
- name: Infrastructure Access Targets
paths:
  /accounts/{account_id}/infrastructure/targets:
    get:
      operationId: infra-targets-list
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/infra_AccountTag'
      - description: Hostname of a target
        in: query
        name: hostname
        schema:
          type:
          - string
          - 'null'
      - description: Partial match to the hostname of a target
        in: query
        name: hostname_contains
        schema:
          type:
          - string
          - 'null'
      - description: Private virtual network identifier of the target
        in: query
        name: virtual_network_id
        schema:
          format: uuid
          type:
          - string
          - 'null'
      - description: IPv4 address of the target
        in: query
        name: ip_v4
        schema:
          type:
          - string
          - 'null'
      - description: IPv6 address of the target
        in: query
        name: ip_v6
        schema:
          type:
          - string
          - 'null'
      - description: Date and time at which the target was created
        in: query
        name: created_after
        schema:
          format: date-time
          type:
          - string
          - 'null'
      - description: Date and time at which the target was modified
        in: query
        name: modified_after
        schema:
          format: date-time
          type:
          - string
          - 'null'
      - description: Current page in the response
        in: query
        name: page
        schema:
          default: 1
          format: int32
          minimum: 1
          type: integer
      - description: Max amount of entries returned per page
        in: query
        name: per_page
        schema:
          default: 1000
          format: int32
          maximum: 1000
          minimum: 1
          type: integer
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/infra_api-response-common-failure'
          description: Failed to retrieve all targets in the account
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/infra_api-response-collection'
                - properties:
                    result:
                      $ref: '#/components/schemas/infra_TargetArray'
                  type: object
          description: Successfully retrieved all targets in the account
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform List all targets
      tags:
      - Infrastructure Access Targets
      x-api-token-group:
      - Teams Read
      - Teams Write
    post:
      operationId: infra-targets-post
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/infra_AccountTag'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                hostname:
                  description: 'A non-unique field that refers to a target. Case insensitive, maximum

                    length of 255 characters, supports the use of special characters dash

                    and period, does not support spaces, and must start and end with an

                    alphanumeric character.'
                  example: infra-access-target
                  type: string
                ip:
                  $ref: '#/components/schemas/infra_IPInfo'
              required:
              - hostname
              - ip
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/infra_api-response-common-failure'
          description: Failed to create the target
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/infra_api-response-single'
                - properties:
                    result:
                      $ref: '#/components/schemas/infra_Target'
                  type: object
          description: Successfully created the target
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Create new target
      tags:
      - Infrastructure Access Targets
      x-api-token-group:
      - Teams Write
  /accounts/{account_id}/infrastructure/targets/{target_id}:
    delete:
      operationId: infra-targets-delete
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/infra_AccountTag'
      - in: path
        name: target_id
        required: true
        schema:
          $ref: '#/components/schemas/infra_TargetId'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/infra_api-response-common-failure'
          description: Failed to delete the target
        '200':
          description: Successfully deleted the target
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Delete target
      tags:
      - Infrastructure Access Targets
    get:
      operationId: infra-targets-get
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/infra_AccountTag'
      - in: path
        name: target_id
        required: true
        schema:
          $ref: '#/components/schemas/infra_TargetId'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/infra_api-response-common-failure'
          description: Failed to retrieve the target
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/infra_api-response-single'
                - properties:
                    result:
                      $ref: '#/components/schemas/infra_Target'
                  type: object
          description: Successfully retrieved the target
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Get target
      tags:
      - Infrastructure Access Targets
    put:
      operationId: infra-targets-put
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/infra_AccountTag'
      - in: path
        name: target_id
        required: true
        schema:
          $ref: '#/components/schemas/infra_TargetId'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                hostname:
                  description: 'A non-unique field that refers to a target. Case insensitive, maximum

                    length of 255 characters, supports the use of special characters dash

                    and period, does not support spaces, and must start and end with an

                    alphanumeric character.'
                  example: infra-access-target
                  type: string
                ip:
                  $ref: '#/components/schemas/infra_IPInfo'
              required:
              - hostname
              - ip
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/infra_api-response-common-failure'
          description: Failed to update the target
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/infra_api-response-single'
                - properties:
                    result:
                      $ref: '#/components/schemas/infra_Target'
                  type: object
          description: Successfully updated the target
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Update target
      tags:
      - Infrastructure Access Targets
components:
  schemas:
    infra_TargetArray:
      items:
        $ref: '#/components/schemas/infra_Target'
      type: array
    infra_AccountTag:
      description: Account identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      title: account_id
      type: string
    infra_IPInfo:
      description: The IPv4/IPv6 address that identifies where to reach a target
      properties:
        ipv4:
          description: The target's IPv4 address
          properties:
            ip_addr:
              description: IP address of the target
              example: 187.26.29.249
              type: string
            virtual_network_id:
              description: Private virtual network identifier for the target
              example: c77b744e-acc8-428f-9257-6878c046ed55
              format: uuid
              type: string
          type: object
        ipv6:
          description: The target's IPv6 address
          properties:
            ip_addr:
              description: IP address of the target
              example: 64c0:64e8:f0b4:8dbf:7104:72b0:ec8f:f5e0
              type: string
            virtual_network_id:
              description: Private virtual network identifier for the target
              example: c77b744e-acc8-428f-9257-6878c046ed55
              format: uuid
              type: string
          type: object
      type: object
    infra_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
    infra_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/infra_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/infra_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
    infra_TargetId:
      description: Target identifier
      example: 0191dce4-9ab4-7fce-b660-8e5dec5172da
      format: uuid
      maxLength: 36
      title: target_id
      type: string
    infra_Target:
      properties:
        created_at:
          description: Date and time at which the target was created
          example: '2019-08-24T14:15:22Z'
          format: date-time
          type: string
        hostname:
          description: A non-unique field that refers to a target
          example: infra-access-target
          type: string
        id:
          $ref: '#/components/schemas/infra_TargetId'
        ip:
          $ref: '#/components/schemas/infra_IPInfo'
        modified_at:
          description: Date and time at which the target was modified
          example: '2019-08-24T14:15:22Z'
          format: date-time
          type: string
      required:
      - id
      - hostname
      - ip
      - created_at
      - modified_at
      type: object
    infra_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/infra_api-response-common'
      - properties:
          result_info:
            $ref: '#/components/schemas/infra_result_info'
      type: object
    infra_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    infra_api-response-single:
      allOf:
      - $ref: '#/components/schemas/infra_api-response-common'
      type: object
    infra_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/infra_messages'
        messages:
          $ref: '#/components/schemas/infra_messages'
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      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