api.md

Workers

Params Types:

• workers.MigrationStepParam
• workers.SingleStepMigrationParam
• workers.WorkerMetadataParam

Response Types:

• workers.MigrationStep
• workers.SingleStepMigration

Beta

Workers

Params Types:

• workers.WorkerParam

Response Types:

• workers.Worker
• workers.BetaWorkerDeleteResponse

Methods:

• client.Workers.Beta.Workers.New(ctx context.Context, params workers.BetaWorkerNewParams) (*workers.Worker, error)
• client.Workers.Beta.Workers.Update(ctx context.Context, workerID string, params workers.BetaWorkerUpdateParams) (*workers.Worker, error)
• client.Workers.Beta.Workers.List(ctx context.Context, params workers.BetaWorkerListParams) (*pagination.V4PagePaginationArray[workers.Worker], error)
• client.Workers.Beta.Workers.Delete(ctx context.Context, workerID string, params workers.BetaWorkerDeleteParams) (*workers.BetaWorkerDeleteResponse, error)
• client.Workers.Beta.Workers.Edit(ctx context.Context, workerID string, params workers.BetaWorkerEditParams) (*workers.Worker, error)
• client.Workers.Beta.Workers.Get(ctx context.Context, workerID string, query workers.BetaWorkerGetParams) (*workers.Worker, error)

Versions

Params Types:

• workers.VersionParam

Response Types:

• workers.Version
• workers.BetaWorkerVersionDeleteResponse

Methods:

• client.Workers.Beta.Workers.Versions.New(ctx context.Context, workerID string, params workers.BetaWorkerVersionNewParams) (*workers.Version, error)
• client.Workers.Beta.Workers.Versions.List(ctx context.Context, workerID string, params workers.BetaWorkerVersionListParams) (*pagination.V4PagePaginationArray[workers.Version], error)
• client.Workers.Beta.Workers.Versions.Delete(ctx context.Context, workerID string, versionID string, body workers.BetaWorkerVersionDeleteParams) (*workers.BetaWorkerVersionDeleteResponse, error)
• client.Workers.Beta.Workers.Versions.Get(ctx context.Context, workerID string, versionID string, params workers.BetaWorkerVersionGetParams) (*workers.Version, error)

Routes

Response Types:

• workers.RouteNewResponse
• workers.RouteUpdateResponse
• workers.RouteListResponse
• workers.RouteDeleteResponse
• workers.RouteGetResponse

Methods:

• client.Workers.Routes.New(ctx context.Context, params workers.RouteNewParams) (*workers.RouteNewResponse, error)
• client.Workers.Routes.Update(ctx context.Context, routeID string, params workers.RouteUpdateParams) (*workers.RouteUpdateResponse, error)
• client.Workers.Routes.List(ctx context.Context, query workers.RouteListParams) (*pagination.SinglePage[workers.RouteListResponse], error)
• client.Workers.Routes.Delete(ctx context.Context, routeID string, body workers.RouteDeleteParams) (*workers.RouteDeleteResponse, error)
• client.Workers.Routes.Get(ctx context.Context, routeID string, query workers.RouteGetParams) (*workers.RouteGetResponse, error)

Assets

Upload

Response Types:

• workers.AssetUploadNewResponse

Methods:

• client.Workers.Assets.Upload.New(ctx context.Context, params workers.AssetUploadNewParams) (*workers.AssetUploadNewResponse, error)

Scripts

Params Types:

• workers.ScriptSettingParam

Response Types:

• workers.Script
• workers.ScriptSetting
• workers.ScriptUpdateResponse
• workers.ScriptListResponse
• workers.ScriptDeleteResponse
• workers.ScriptSearchResponse

Methods:

• client.Workers.Scripts.Update(ctx context.Context, scriptName string, params workers.ScriptUpdateParams) (*workers.ScriptUpdateResponse, error)
• client.Workers.Scripts.List(ctx context.Context, params workers.ScriptListParams) (*pagination.SinglePage[workers.ScriptListResponse], error)
• client.Workers.Scripts.Delete(ctx context.Context, scriptName string, params workers.ScriptDeleteParams) (*workers.ScriptDeleteResponse, error)
• client.Workers.Scripts.Get(ctx context.Context, scriptName string, query workers.ScriptGetParams) (*string, error)
• client.Workers.Scripts.Search(ctx context.Context, params workers.ScriptSearchParams) (*[]workers.ScriptSearchResponse, error)

Assets

Upload

Response Types:

• workers.ScriptAssetUploadNewResponse

Methods:

• client.Workers.Scripts.Assets.Upload.New(ctx context.Context, scriptName string, params workers.ScriptAssetUploadNewParams) (*workers.ScriptAssetUploadNewResponse, error)

Subdomain

Response Types:

• workers.ScriptSubdomainNewResponse
• workers.ScriptSubdomainDeleteResponse
• workers.ScriptSubdomainGetResponse

Methods:

• client.Workers.Scripts.Subdomain.New(ctx context.Context, scriptName string, params workers.ScriptSubdomainNewParams) (*workers.ScriptSubdomainNewResponse, error)
• client.Workers.Scripts.Subdomain.Delete(ctx context.Context, scriptName string, body workers.ScriptSubdomainDeleteParams) (*workers.ScriptSubdomainDeleteResponse, error)
• client.Workers.Scripts.Subdomain.Get(ctx context.Context, scriptName string, query workers.ScriptSubdomainGetParams) (*workers.ScriptSubdomainGetResponse, error)

Schedules

Response Types:

• workers.ScriptScheduleUpdateResponse
• workers.ScriptScheduleGetResponse

Methods:

• client.Workers.Scripts.Schedules.Update(ctx context.Context, scriptName string, params workers.ScriptScheduleUpdateParams) (*workers.ScriptScheduleUpdateResponse, error)
• client.Workers.Scripts.Schedules.Get(ctx context.Context, scriptName string, query workers.ScriptScheduleGetParams) (*workers.ScriptScheduleGetResponse, error)

Tail

Params Types:

• workers.ConsumerScriptParam

Response Types:

• workers.ConsumerScript
• workers.ScriptTailNewResponse
• workers.ScriptTailDeleteResponse
• workers.ScriptTailGetResponse

Methods:

• client.Workers.Scripts.Tail.New(ctx context.Context, scriptName string, body workers.ScriptTailNewParams) (*workers.ScriptTailNewResponse, error)
• client.Workers.Scripts.Tail.Delete(ctx context.Context, scriptName string, id string, body workers.ScriptTailDeleteParams) (*workers.ScriptTailDeleteResponse, error)
• client.Workers.Scripts.Tail.Get(ctx context.Context, scriptName string, query workers.ScriptTailGetParams) (*workers.ScriptTailGetResponse, error)

Content

Methods:

• client.Workers.Scripts.Content.Update(ctx context.Context, scriptName string, params workers.ScriptContentUpdateParams) (*workers.Script, error)
• client.Workers.Scripts.Content.Get(ctx context.Context, scriptName string, query workers.ScriptContentGetParams) (*http.Response, error)

Settings

Methods:

• client.Workers.Scripts.Settings.Edit(ctx context.Context, scriptName string, params workers.ScriptSettingEditParams) (*workers.ScriptSetting, error)
• client.Workers.Scripts.Settings.Get(ctx context.Context, scriptName string, query workers.ScriptSettingGetParams) (*workers.ScriptSetting, error)

Deployments

Params Types:

• workers.DeploymentParam

Response Types:

• workers.Deployment
• workers.ScriptDeploymentListResponse
• workers.ScriptDeploymentDeleteResponse

Methods:

• client.Workers.Scripts.Deployments.New(ctx context.Context, scriptName string, params workers.ScriptDeploymentNewParams) (*workers.Deployment, error)
• client.Workers.Scripts.Deployments.List(ctx context.Context, scriptName string, params workers.ScriptDeploymentListParams) (*pagination.V4PagePagination[workers.ScriptDeploymentListResponse], error)
• client.Workers.Scripts.Deployments.Delete(ctx context.Context, scriptName string, deploymentID string, body workers.ScriptDeploymentDeleteParams) (*workers.ScriptDeploymentDeleteResponse, error)
• client.Workers.Scripts.Deployments.Get(ctx context.Context, scriptName string, deploymentID string, query workers.ScriptDeploymentGetParams) (*workers.Deployment, error)

Versions

Response Types:

• workers.ScriptVersionNewResponse
• workers.ScriptVersionListResponse
• workers.ScriptVersionGetResponse

Methods:

• client.Workers.Scripts.Versions.New(ctx context.Context, scriptName string, params workers.ScriptVersionNewParams) (*workers.ScriptVersionNewResponse, error)
• client.Workers.Scripts.Versions.List(ctx context.Context, scriptName string, params workers.ScriptVersionListParams) (*pagination.V4PagePagination[workers.ScriptVersionListResponse], error)
• client.Workers.Scripts.Versions.Get(ctx context.Context, scriptName string, versionID string, query workers.ScriptVersionGetParams) (*workers.ScriptVersionGetResponse, error)

Secrets

Response Types:

• workers.ScriptSecretUpdateResponse
• workers.ScriptSecretListResponse
• workers.ScriptSecretDeleteResponse
• workers.ScriptSecretBulkUpdateResponse
• workers.ScriptSecretGetResponse

Methods:

• client.Workers.Scripts.Secrets.Update(ctx context.Context, scriptName string, params workers.ScriptSecretUpdateParams) (*workers.ScriptSecretUpdateResponse, error)
• client.Workers.Scripts.Secrets.List(ctx context.Context, scriptName string, query workers.ScriptSecretListParams) (*pagination.SinglePage[workers.ScriptSecretListResponse], error)
• client.Workers.Scripts.Secrets.Delete(ctx context.Context, scriptName string, secretName string, params workers.ScriptSecretDeleteParams) (*workers.ScriptSecretDeleteResponse, error)
• client.Workers.Scripts.Secrets.BulkUpdate(ctx context.Context, scriptName string, params workers.ScriptSecretBulkUpdateParams) (*workers.ScriptSecretBulkUpdateResponse, error)
• client.Workers.Scripts.Secrets.Get(ctx context.Context, scriptName string, secretName string, params workers.ScriptSecretGetParams) (*workers.ScriptSecretGetResponse, error)

ScriptAndVersionSettings

Response Types:

• workers.ScriptScriptAndVersionSettingEditResponse
• workers.ScriptScriptAndVersionSettingGetResponse

Methods:

• client.Workers.Scripts.ScriptAndVersionSettings.Edit(ctx context.Context, scriptName string, params workers.ScriptScriptAndVersionSettingEditParams) (*workers.ScriptScriptAndVersionSettingEditResponse, error)
• client.Workers.Scripts.ScriptAndVersionSettings.Get(ctx context.Context, scriptName string, query workers.ScriptScriptAndVersionSettingGetParams) (*workers.ScriptScriptAndVersionSettingGetResponse, error)

AccountSettings

Response Types:

• workers.AccountSettingUpdateResponse
• workers.AccountSettingGetResponse

Methods:

• client.Workers.AccountSettings.Update(ctx context.Context, params workers.AccountSettingUpdateParams) (*workers.AccountSettingUpdateResponse, error)
• client.Workers.AccountSettings.Get(ctx context.Context, query workers.AccountSettingGetParams) (*workers.AccountSettingGetResponse, error)

Domains

Response Types:

• workers.DomainUpdateResponse
• workers.DomainListResponse
• workers.DomainDeleteResponse
• workers.DomainGetResponse

Methods:

• client.Workers.Domains.Update(ctx context.Context, params workers.DomainUpdateParams) (*workers.DomainUpdateResponse, error)
• client.Workers.Domains.List(ctx context.Context, params workers.DomainListParams) (*pagination.SinglePage[workers.DomainListResponse], error)
• client.Workers.Domains.Delete(ctx context.Context, domainID string, body workers.DomainDeleteParams) (*workers.DomainDeleteResponse, error)
• client.Workers.Domains.Get(ctx context.Context, domainID string, query workers.DomainGetParams) (*workers.DomainGetResponse, error)

Subdomains

Response Types:

• workers.SubdomainUpdateResponse
• workers.SubdomainGetResponse

Methods:

• client.Workers.Subdomains.Update(ctx context.Context, params workers.SubdomainUpdateParams) (*workers.SubdomainUpdateResponse, error)
• client.Workers.Subdomains.Delete(ctx context.Context, body workers.SubdomainDeleteParams) error
• client.Workers.Subdomains.Get(ctx context.Context, query workers.SubdomainGetParams) (*workers.SubdomainGetResponse, error)

Observability

Telemetry

Response Types:

• workers.ObservabilityTelemetryKeysResponse
• workers.ObservabilityTelemetryLiveTailResponse
• workers.ObservabilityTelemetryLiveTailHeartbeatResponse
• workers.ObservabilityTelemetryQueryResponse
• workers.ObservabilityTelemetryValuesResponse

Methods:

• client.Workers.Observability.Telemetry.Keys(ctx context.Context, params workers.ObservabilityTelemetryKeysParams) (*pagination.SinglePage[workers.ObservabilityTelemetryKeysResponse], error)
• client.Workers.Observability.Telemetry.LiveTail(ctx context.Context, params workers.ObservabilityTelemetryLiveTailParams) (*workers.ObservabilityTelemetryLiveTailResponse, error)
• client.Workers.Observability.Telemetry.LiveTailHeartbeat(ctx context.Context, params workers.ObservabilityTelemetryLiveTailHeartbeatParams) (*workers.ObservabilityTelemetryLiveTailHeartbeatResponse, error)
• client.Workers.Observability.Telemetry.Query(ctx context.Context, params workers.ObservabilityTelemetryQueryParams) (*workers.ObservabilityTelemetryQueryResponse, error)
• client.Workers.Observability.Telemetry.Values(ctx context.Context, params workers.ObservabilityTelemetryValuesParams) (*pagination.SinglePage[workers.ObservabilityTelemetryValuesResponse], error)

Destinations

Response Types:

• workers.ObservabilityDestinationNewResponse
• workers.ObservabilityDestinationUpdateResponse
• workers.ObservabilityDestinationListResponse
• workers.ObservabilityDestinationDeleteResponse

Methods:

• client.Workers.Observability.Destinations.New(ctx context.Context, params workers.ObservabilityDestinationNewParams) (*workers.ObservabilityDestinationNewResponse, error)
• client.Workers.Observability.Destinations.Update(ctx context.Context, slug string, params workers.ObservabilityDestinationUpdateParams) (*workers.ObservabilityDestinationUpdateResponse, error)
• client.Workers.Observability.Destinations.List(ctx context.Context, params workers.ObservabilityDestinationListParams) (*pagination.SinglePage[workers.ObservabilityDestinationListResponse], error)
• client.Workers.Observability.Destinations.Delete(ctx context.Context, slug string, body workers.ObservabilityDestinationDeleteParams) (*workers.ObservabilityDestinationDeleteResponse, error)

Queries

Response Types:

• workers.ObservabilityQueryNewResponse
• workers.ObservabilityQueryListResponse

Methods:

• client.Workers.Observability.Queries.New(ctx context.Context, params workers.ObservabilityQueryNewParams) (*workers.ObservabilityQueryNewResponse, error)
• client.Workers.Observability.Queries.List(ctx context.Context, params workers.ObservabilityQueryListParams) (*pagination.SinglePage[workers.ObservabilityQueryListResponse], error)

SharedQueries

Response Types:

• workers.ObservabilitySharedQueryNewResponse
• workers.ObservabilitySharedQueryGetResponse

Methods:

• client.Workers.Observability.SharedQueries.New(ctx context.Context, params workers.ObservabilitySharedQueryNewParams) (*workers.ObservabilitySharedQueryNewResponse, error)
• client.Workers.Observability.SharedQueries.Get(ctx context.Context, id string, params workers.ObservabilitySharedQueryGetParams) (*workers.ObservabilitySharedQueryGetResponse, error)