Search Workers

client.Workers.Scripts.Search(ctx, params) (*[]ScriptSearchResponse, error)

GET/accounts/{account_id}/workers/scripts-search

Search for Workers in an account.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Workers Tail ReadWorkers Scripts WriteWorkers Scripts Read

ParametersExpand Collapse

params ScriptSearchParams

AccountID param.Field[string]

Path param: Identifier.

maxLength32

ID param.Field[string]optional

Query param: Worker ID (also called tag) to search for. Only exact matches are returned.

Name param.Field[string]optional

Query param: Worker name to search for. Both exact and partial matches are returned.

OrderBy param.Field[ScriptSearchParamsOrderBy]optional

Query param: Property to sort results by. Results are sorted in ascending order.

const ScriptSearchParamsOrderByCreatedOn ScriptSearchParamsOrderBy = "created_on"

const ScriptSearchParamsOrderByModifiedOn ScriptSearchParamsOrderBy = "modified_on"

const ScriptSearchParamsOrderByName ScriptSearchParamsOrderBy = "name"

Page param.Field[int64]optional

Query param: Current page.

minimum1

PerPage param.Field[int64]optional

Query param: Items per page.

maximum100

minimum1

ReturnsExpand Collapse

type ScriptSearchResponseEnvelopeResult []ScriptSearchResponse

ID string

Identifier.

maxLength32

CreatedOn Time

When the script was created.

formatdate-time

ModifiedOn Time

When the script was last modified.

formatdate-time

ScriptName string

Name of the script, used in URLs and route configuration.

EnvironmentIsDefault booloptional

Whether the environment is the default environment.

EnvironmentName stringoptional

Name of the environment.

ServiceName stringoptional

Name of the service.

Search Workers

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/option"
  "github.com/cloudflare/cloudflare-go/workers"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  response, err := client.Workers.Scripts.Search(context.TODO(), workers.ScriptSearchParams{
    AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response)
}

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "id": "023e105f4ecef8ad9ca31a8372d0c353",
      "created_on": "2017-01-01T00:00:00Z",
      "modified_on": "2017-01-01T00:00:00Z",
      "script_name": "this-is_my_script-01",
      "environment_is_default": true,
      "environment_name": "production",
      "service_name": "my-service"
    }
  ],
  "success": true,
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 100
  }
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "id": "023e105f4ecef8ad9ca31a8372d0c353",
      "created_on": "2017-01-01T00:00:00Z",
      "modified_on": "2017-01-01T00:00:00Z",
      "script_name": "this-is_my_script-01",
      "environment_is_default": true,
      "environment_name": "production",
      "service_name": "my-service"
    }
  ],
  "success": true,
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 100
  }
}