APIs.io Engineering Platform Worker Tail Logs 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 Worker Tail Logs API
  version: 4.0.0
tags:
- name: Worker Tail Logs
paths:
  /accounts/{account_id}/workers/scripts/{script_name}/tails:
    get:
      description: Get list of tails currently deployed on a Worker.
      operationId: worker-tail-logs-list-tails
      parameters:
      - in: path
        name: script_name
        required: true
        schema:
          $ref: '#/components/schemas/workers_script_name'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/workers_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/workers_tail-response'
                - $ref: '#/components/schemas/workers_api-response-common-failure'
          description: List Tails response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_tail-response'
          description: List Tails response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List Tails
      tags:
      - Worker Tail Logs
      x-api-token-group:
      - Workers Tail Read
      - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.script.read
    post:
      description: Starts a tail that receives logs and exception from a Worker.
      operationId: worker-tail-logs-start-tail
      parameters:
      - in: path
        name: script_name
        required: true
        schema:
          $ref: '#/components/schemas/workers_script_name'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/workers_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/workers_tail-response'
                - $ref: '#/components/schemas/workers_api-response-common-failure'
          description: Start Tail response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_tail-response'
          description: Start Tail response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Start Tail
      tags:
      - Worker Tail Logs
      x-api-token-group:
      - Workers Tail Read
      - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.script.read
        - com.cloudflare.edge.worker.tail.create
  /accounts/{account_id}/workers/scripts/{script_name}/tails/{id}:
    delete:
      description: Deletes a tail from a Worker.
      operationId: worker-tail-logs-delete-tail
      parameters:
      - in: path
        name: id
        required: true
        schema:
          $ref: '#/components/schemas/workers_id'
      - in: path
        name: script_name
        required: true
        schema:
          $ref: '#/components/schemas/workers_script_name'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/workers_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/workers_api-response-common'
                - $ref: '#/components/schemas/workers_api-response-common-failure'
          description: Delete Tail response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_api-response-common'
          description: Delete Tail response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete Tail
      tags:
      - Worker Tail Logs
      x-api-token-group:
      - Workers Tail Read
      - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.script.read
        - com.cloudflare.edge.worker.tail.create
components:
  schemas:
    workers_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/workers_messages'
        messages:
          $ref: '#/components/schemas/workers_messages'
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      type: object
    workers_id:
      description: Identifier for the tail.
      example: 03dc9f77817b488fb26c5861ec18f791
      type: string
    workers_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    workers_script_name:
      description: Name of the script, used in URLs and route configuration.
      example: this-is_my_script-01
      pattern: ^[a-z0-9_][a-z0-9-_]*$
      type: string
    workers_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/workers_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/workers_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
    workers_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    workers_tail-response:
      allOf:
      - $ref: '#/components/schemas/workers_api-response-common'
      - properties:
          result:
            properties:
              expires_at:
                readOnly: true
                type: string
              id:
                readOnly: true
                type: string
              url:
                readOnly: true
                type: string
            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