Change the state of a CAS server

put/servers/{serverName}/state
Internal-Use Only

Request a change to the state of a CAS server. Call with an Accept header of application/json;text/plain to properly receive both success and error response types. After the state change is requested, the server will transition to the requested state. Check the interim server state by making a GET call on the same endpoint.

Request Samples

1

Response Samples

1stopped

Path Parameters

NameTypeRequiredDescription
serverName
string
true

The name of the CAS server.

Query Parameters

NameTypeRequiredDescription
sessionId
string
false

The optional ID of the CAS session.

value
string
true

State to which to set the server:

  • running - start the CAS server if it is not already started.
  • stopped - shutdown the CAS server if it is currently running.
Allowed values:
runningstopped

Responses

StatusMeaningDescription
200OKThe request was completed successfully. States starting and stopping are temporary states while the server is in transition.Schema
400Bad RequestThe request was invalid.Schema
404Not FoundThe requested CAS server does not exist.
409ConflictThe request could not be completed due to a conflict with the current state of the resource. Details are included in the response body.