Use this call to change the model's status to either online or offline.
Ensure the model is in either standard or deployed mode. The requesting user must hold the Workspace Administrator role.
This endpoint's request body carries the status property, which must have the value online or offline to change the state of the model.
For best performance and outcomes, make all API calls to your closest regional server. To learn more about this, read URL, IP, and allowlist requirements.
Method and endpoint
/models/{modelId}/onlineStatus
Parameters
| Parameter | Details |
modelId | Required path parameter. This identifies the model to be changed. |
Curl example
curl -X PUT 'https://api.anaplan.com/2/0/models/{modelId}/onlineStatus' \
-H 'Authorization: AnaplanAuthToken {anaplan_auth_token}' \
-H 'Content-Type: application/json' \
--data-raw '{ "status": "online" }'
Response
If your request is successful, the server returns a 204 HTTP status code with no body.
Note: The target model must be unlocked and unarchived. Calling this endpoint on archived models returns an HTTP 422 status code with an Archived error response.
Review the ALM API troubleshooting guide to resolve any error responses from API calls.