Skip to navigation
EdgeWorkers APIEdge Worker Ids

Create a new EdgeWorker ID

Register a new EdgeWorker within a particular group.

Query parameters

accountSwitchKeystringOptional

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Request

This endpoint expects an object.
groupIdintegerRequired>=1
Identifies a group to assign to the EdgeWorker.
namestringRequired>=1 character
A name you assign to the EdgeWorker.
resourceTierIdintegerRequired>=1

Unique identifier of a resource tier. The resource tier is write-once data. To change the resource tier you need to Clone an EdgeWorker ID.

descriptionstringOptional1-128 characters
Description of the EdgeWorker.

Response

This section describes attributes of an EdgeWorker registration.
groupIdinteger>=1
Group identified by the user who created the EdgeWorker.
namestring>=1 character
Name given by the user who created the EdgeWorker.
resourceTierIdinteger>=1
Resource tier selected when the EdgeWorker was created.
accountIdstringOptional>=1 character
Identifier for the account under which the EdgeWorker was created.
createdBystringOptional>=1 character
Username of the person who created the EdgeWorker.
createdTimedatetimeOptional
ISO 8601 timestamp indicating when the EdgeWorker was created.
descriptionstringOptional1-128 characters
Description of the EdgeWorker.
edgeWorkerIdintegerOptional>=1
Unique identifier of the EdgeWorker.
lastModifiedBystringOptional>=1 character
Username of the person who most recently updated the EdgeWorker.
lastModifiedTimedatetimeOptional
ISO 8601 timestamp indicating when the EdgeWorker was most recently modified.