Edge Functions

Edge computing function endpoints

get

GET /api/v1/edge/name/check

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
get
/api/v1/edge/name/check
get

GET /api/v1/edge/

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
get
/api/v1/edge/
get

GET /api/v1/edge/{id}

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Path parameters
idstringRequired

Path parameter: id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
get
/api/v1/edge/{id}
get

GET /api/v1/edge/{id}/logs

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Path parameters
idstringRequired

Path parameter: id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
get
/api/v1/edge/{id}/logs
get

GET /api/v1/edge/{id}/metrics

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Path parameters
idstringRequired

Path parameter: id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
get
/api/v1/edge/{id}/metrics
get

GET /api/v1/edge/{id}/endpoint

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Path parameters
idstringRequired

Path parameter: id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
get
/api/v1/edge/{id}/endpoint
get

GET /api/v1/edge/{id}/versions

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Path parameters
idstringRequired

Path parameter: id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
get
/api/v1/edge/{id}/versions
post

POST /api/v1/edge/{id}/rollback

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Path parameters
idstringRequired

Path parameter: id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Body
organization_idanyOptionalExample: any
whereanyOptionalExample: any
Responses
200

OK

application/json
Responseobject
post
/api/v1/edge/{id}/rollback
post

POST /api/v1/edge/create

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Body
sluganyOptionalExample: any
lengthanyOptionalExample: any
organization_idanyOptionalExample: any
nameanyOptionalExample: any
runtimeanyOptionalExample: any
zipFileanyOptionalExample: any
memoryanyOptionalExample: any
timeoutanyOptionalExample: any
paramsanyOptionalExample: any
Responses
200

OK

application/json
Responseobject
post
/api/v1/edge/create
put

PUT /api/v1/edge/update/{id}

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Path parameters
idstringRequired

Path parameter: id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Body
organization_idanyOptionalExample: any
whereanyOptionalExample: any
Responses
200

OK

application/json
Responseobject
put
/api/v1/edge/update/{id}
delete

DELETE /api/v1/edge/delete/{id}

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Path parameters
idstringRequired

Path parameter: id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
delete
/api/v1/edge/delete/{id}
post

POST /api/v1/edge/{id}/test

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Path parameters
idstringRequired

Path parameter: id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Body
organization_idanyOptionalExample: any
whereanyOptionalExample: any
Responses
200

OK

application/json
Responseobject
post
/api/v1/edge/{id}/test

Last updated