scripts_scriptID.yml

get:
  operationId: GetScriptsID
  tags:
    - Data I/O endpoints
    - Invokable Scripts
  summary: Retrieve a script
  description: |
    Retrieves a [script](https://docs.influxdata.com/influxdb/cloud/api-guide/api-invokable-scripts/).

    #### Related Guides

    - [Invoke custom scripts](https://docs.influxdata.com/influxdb/cloud/api-guide/api-invokable-scripts/)
  parameters:
    - in: path
      name: scriptID
      schema:
        type: string
      required: true
      description: |
        A script ID.
        Retrieves the specified script.
  responses:
    '200':
      description: Success. The response body contains the script.
      content:
        application/json:
          schema:
            $ref: '../schemas/Script.yml'
          examples:
            $ref: '../schemas/ScriptGetResponse.yml'
    "401":
      $ref: "../../../common/responses/AuthorizationError.yml"
    "500":
      $ref: "../../../common/responses/InternalServerError.yml"
    '404':
      description: |
        Not found.
      content:
        application/json:
          schema:
            $ref: "../../../common/schemas/Error.yml"
          examples:
            notFound:
              summary: |
                The requested script was not found.
              value: {
                "code":"not found",
                "message":"script \"09afa3b220fe400\" not found"
              }
    default:
      description: Internal server error.
      $ref: '../../../common/responses/ServerError.yml'
patch:
  operationId: PatchScriptsID
  tags:
    - Invokable Scripts
  summary: Update a script
  description: |
    Updates an invokable script.

    Use this endpoint to modify values for script properties (`description` and `script`).

    To update a script, pass an object that contains the updated key-value pairs.

    #### Limitations

    - If you send an empty request body, the script will neither update nor
    store an empty script, but InfluxDB will respond with an HTTP `200` status
    code.

    #### Related Guides

    - [Invoke custom scripts](https://docs.influxdata.com/influxdb/cloud/api-guide/api-invokable-scripts/)
  requestBody:
    description: |
      An object that contains the updated script properties to apply.
    required: true
    content:
      application/json:
        schema:
          $ref: '../schemas/ScriptUpdateRequest.yml'
  parameters:
    - in: path
      name: scriptID
      schema:
        type: string
      required: true
      description: |
        A script ID.
        Updates the specified script.
  responses:
    '200':
      description: Success. The response body contains the updated script.
      content:
        application/json:
          schema:
            $ref: '../schemas/Script.yml'
          examples:
            $ref: '../schemas/ScriptUpdateResponse.yml'
    "401":
      $ref: "../../../common/responses/AuthorizationError.yml"
    "500":
      $ref: "../../../common/responses/InternalServerError.yml"
    '404':
      description: |
        Not found.
      content:
        application/json:
          schema:
            $ref: "../../../common/schemas/Error.yml"
          examples:
            notFound:
              summary: |
                The requested script wasn't found.
              value: {
                "code": "not found",
                "message": "script \"09afa3b220fe400\" not found"
              }
    default:
      description: Internal server error
      $ref: '../../../common/responses/ServerError.yml'
  x-codeSamples:
    - lang: Shell
      label: cURL
      source: |
        curl -X 'PATCH' \
          "https://cloud2.influxdata.com/api/v2/scripts/SCRIPT_ID" \
          --header "Authorization: Token INFLUX_TOKEN" \
          --header "Accept: application/json"
          --header "Content-Type: application/json"
          --data '{
              "description": "get last point from new bucket",
              "script": "from(bucket: updatedBucket) |> range(start: -7d) |> limit(n:1)", "language": "flux"
            }'
delete:
  operationId: DeleteScriptsID
  tags:
    - Invokable Scripts
  summary: Delete a script
  description: |
    Deletes a [script](https://docs.influxdata.com/influxdb/cloud/api-guide/api-invokable-scripts/) and all associated records.

    #### Limitations

    - You can delete only one script per request.
    - If the script ID you provide doesn't exist for the organization, InfluxDB
    responds with an HTTP `204` status code.

    #### Related Guides

    - [Invoke custom scripts](https://docs.influxdata.com/influxdb/cloud/api-guide/api-invokable-scripts/)
  parameters:
    - in: path
      name: scriptID
      schema:
        type: string
      required: true
      description: |
        A script ID.
        Deletes the specified script.
  responses:
    '204':
      description: |
        Success.
        The script is queued for deletion.
    "401":
      $ref: "../../../common/responses/AuthorizationError.yml"
    "500":
      $ref: "../../../common/responses/InternalServerError.yml"
    default:
      description: Unexpected error
      $ref: '../../../common/responses/ServerError.yml'
  x-codeSamples:
    - lang: Shell
      label: cURL
      source: |
        curl -X 'DELETE' \
          "https://cloud2.influxdata.com/api/v2/scripts/SCRIPT_ID" \
          --header "Authorization: Token INFLUX_TOKEN" \
          --header 'Accept: application/json'