Skip to main content

Resource API Status

Poll the status of an asynchronous operation by its job ID. Create/update/scale calls that run asynchronously return a jobId — poll here until the job completes.

Resource base path: /restapi/asyncjob

MethodPathDescription
GET/restapi/asyncjob/resourceStatusResource Status
note

apikey and secretkey are required HTTP headers on every request and are omitted from the parameter tables below. See Authentication.


Resource Status​

Find the status of an asynchronous resource operation by job ID.

GET /restapi/asyncjob/resourceStatus

Parameters​

ParameterInTypeRequiredDescription
jobIdquerystring✅ YesJob ID returned by the asynchronous operation.

Example request​

curl -X GET \
"https://portal.your-domain.com/restapi/asyncjob/resourceStatus?jobId=VALUE" \
-H "apikey: YOUR_API_KEY" \
-H "secretkey: YOUR_SECRET_KEY"

Responses​

CodeDescription
200Successful operation.
401Invalid authentication credentials.
550Permission denied.
{
"jobId": "string",
"resourceId": "string",
"errorMessage": "string",
"errorCode": 1,
"resourceType": "string",
"status": "Active"
}