CI Lifecycle Management API

The CI Lifecycle Management API provides endpoints to manipulate configuration item (CI) operational states and apply CI actions.

The API interfaces adhere to restrictions and allowances specified by not allowed CI actions, compatible CI actions, and not allowed operational transitions. If an interface attempts a restricted operation, the operation is blocked, an error is logged, and a task is created if appropriate.

Parent Topic:REST API reference

CI Lifecycle Management - DELETE /now/cilifecyclemgmt/actions

Removes a configuration item (CI) action for a list of CIs.

URL format

Versioned URL: /api/now/{api_version}/cilifecyclemgmt/actions

Default URL: /api/now/cilifecyclemgmt/actions

Note: Available versions are specified in the REST API Explorer. For scripted REST APIs there is additional version information on the Scripted REST Service form.

Supported request parameters

Headers

The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Response body parameters (JSON or XML)

</td></tr><tr><td>

result.errors

</td><td>

List of objects in which each object represents an error encountered while processing the request.Data type: Array

 ```
"errors": [
  {
    "error": "String",
    "message": "String"
  }
]

cURL request

Remove a CI action from two CIs.

curl --request DELETE \
'https://instance.service-now.com/api/now/cilifecyclemgmt/actions?actionName=Patching&requestorId=621b5a09309e5010f877773aa7167c0a&sysIds=00a9a80d3790200044e0bfc8bcbe5d1c,d0fdbc8437201000deeabfc8bcbe5d33' \
--header 'Accept: application/json' \
--user "username":"password"

The response body confirms that the CI action was removed from the CIs.

{
  "result": {
    "result": true
  }
}

CI Lifecycle Management - DELETE /now/cilifecyclemgmt/operators/{req_id}

Unregisters an operator for non-workflow users.

URL format

Versioned URL: /api/now/{api_version}/cilifecyclemgmt/operators/{req_id}

Default URL: /api/now/cilifecyclemgmt/operators/{req_id}

Note: Available versions are specified in the REST API Explorer. For scripted REST APIs there is additional version information on the Scripted REST Service form.

Supported request parameters

Headers

The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Response body parameters (JSON or XML)

</td></tr><tr><td>

result.errors

</td><td>

List of objects in which each object represents an error encountered while processing the request.Data type: Array

 ```
"errors": [
  {
    "error": "String",
    "message": "String"
  }
]

cURL request

Unregister an operator by user ID.

curl --request DELETE \
"https://instance.service-now.com/api/now/cilifecyclemgmt/operators/3cf1b3cc30121010f877773aa7167c6e" \
--header "Accept: application/json" \
--user "username":"password"

The response body verifies that the operator was unregistered.

{
  "result": {
    "result": true
  }
}

CI Lifecycle Management - GET /now/cilifecyclemgmt/actions/{sys_id}

Returns a list of active configuration item (CI) actions for the specified CI.

URL format

Versioned URL: /api/now/{api_version}/cilifecyclemgmt/actions/{sys_id}

Default URL: /api/now/cilifecyclemgmt/actions/{sys_id}

Note: Available versions are specified in the REST API Explorer. For scripted REST APIs there is additional version information on the Scripted REST Service form.

Supported request parameters

Headers

The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Response body parameters (JSON or XML)

</td></tr><tr><td>

result.ciActions

</td><td>

Comma-separated list of active CI actions for the CI, or `no_active_action` if none were found.Data type: String

</td></tr><tr><td>

result.errors

</td><td>

List of objects in which each object represents an error encountered while processing the request.Data type: Array

 ```
"errors": [
  {
    "error": "String",
    "message": "String"
  }
]

cURL request

curl --request GET \
'https://instance.service-now.com/api/now/cilifecyclemgmt/actions/00a9a80d3790200044e0bfc8bcbe5d1c' \
--header 'Accept: application/json' \
--user "username":"password"

The response body shows that no CI actions are active for the specified CI.

{
  "result": {
    "ciActions": [
      "no_active_action"
    ],
    "result": true
  }
}

CI Lifecycle Management - GET /now/cilifecyclemgmt/compatActions

Determines whether two specified configuration item (CI) actions are compatible.

URL format

Versioned URL: /api/now/{api_version}/cilifecyclemgmt/compatActions

Default URL: /api/now/cilifecyclemgmt/compatActions

Note: Available versions are specified in the REST API Explorer. For scripted REST APIs there is additional version information on the Scripted REST Service form.

Supported request parameters

Headers

The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Response body parameters (JSON or XML)

cURL request

Check compatibility of Patching and Provisioning CI actions.

curl --request GET \
'https://instance.service-now.com/api/now/cilifecyclemgmt/compatActions?actionName=Patching&otherActionName=Provisioning' \
--header 'Accept: application/json' \
--user "username":"password"

The response body confirms that the two CI actions are compatible.

{
  "result": true
}

CI Lifecycle Management - GET /now/cilifecyclemgmt/leases/{sys_id}/expired

Determines whether the lease has expired for the requestor of a configuration item (CI) action applied to the specified CI.

URL format

Versioned URL: /api/now/{api_version}/cilifecyclemgmt/leases/{sys_id}/expired

Default URL: /api/now/cilifecyclemgmt/leases/{sys_id}/expired

Note: Available versions are specified in the REST API Explorer. For scripted REST APIs there is additional version information on the Scripted REST Service form.

Supported request parameters

Headers

The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Response body parameters (JSON or XML)

</td></tr><tr><td>

result.errors

</td><td>

List of objects in which each object represents an error encountered while processing the request.Data type: Array

 ```
"errors": [
  {
    "error": "String",
    "message": "String"
  }
]

cURL request

curl --request GET \
'https://instance.service-now.com/api/now/cilifecyclemgmt/leases/00a9a80d3790200044e0bfc8bcbe5d1c/expired?actionName=Patching&requestorId=621b5a09309e5010f877773aa7167c0a' \
--header 'Accept: application/json' \
--user "username":"password"

The response body shows that the lease for the requestor of the applied CI action has not expired.

{
  "result": {
    "result": false
  }
}

CI Lifecycle Management - GET /now/cilifecyclemgmt/notAllowedAction

Determines whether a specified configuration item (CI) action is not allowed for a CI of a specified class when in a specified operational state.

URL format

Versioned URL: /api/now/{api_version}/cilifecyclemgmt/notAllowedAction

Default URL: /api/now/cilifecyclemgmt/notAllowedAction

Note: Available versions are specified in the REST API Explorer. For scripted REST APIs there is additional version information on the Scripted REST Service form.

Supported request parameters

Headers

The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Response body parameters (JSON or XML)

cURL request

Check whether the Patching CI action is restricted (not allowed) for computers in the DR Standby operational state.

curl --request GET \
"https://instance.service-now.com/api/now/cilifecyclemgmt/notAllowedAction?actionName=Patching&ciClass=cmdb_ci_computer&opsLabel=DR+Standby" \
--header "Accept: application/json" \
--user "username":"password"

The response body confirms that this action is restricted (not allowed) for the specified CI class when in the specified operational state.

{
  "result": true
}

CI Lifecycle Management - GET /now/cilifecyclemgmt/notAllowedOpsTransition

Determines whether a configuration item (CI) from a specified class can transition from a specified operational state to a second specified operational state.

URL format

Versioned URL: /api/now/{api_version}/cilifecyclemgmt/notAllowedOpsTransition

Default URL: /api/now/cilifecyclemgmt/notAllowedOpsTransition

Note: Available versions are specified in the REST API Explorer. For scripted REST APIs there is additional version information on the Scripted REST Service form.

Supported request parameters

Headers

The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Response body parameters (JSON or XML)

cURL request

Check whether transition from Retired operational state to DR Standby operational state is restricted (not allowed) for Linux server CIs.

curl --request GET \
"https://instance.service-now.com/api/now/cilifecyclemgmt/notAllowedOpsTransition?ciClass=cmdb_ci_computer&opsLabel=Retired&transitionOpsLabel=DR+Standby" \
--header "Accept: application/json" \
--user "username":"password"

The response body shows that the specified operational state transition is unrestricted (allowed) for this CI class.

{
  "result": false
}

CI Lifecycle Management - GET /now/cilifecyclemgmt/requestors/{req_id}/valid

Determines whether the specified active workflow user or registered user is a valid requestor.

URL format

Versioned URL: /api/now/{api_version}/cilifecyclemgmt/requestors/{req_id}/valid

Default URL: /api/now/cilifecyclemgmt/requestors/{req_id}/valid

Note: Available versions are specified in the REST API Explorer. For scripted REST APIs there is additional version information on the Scripted REST Service form.

Supported request parameters

Headers

The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Response body parameters (JSON or XML)

</td></tr><tr><td>

result.errors

</td><td>

List of objects in which each object represents an error encountered while processing the request.Data type: Array

 ```
"errors": [
  {
    "error": "String",
    "message": "String"
  }
]

cURL request

curl --request GET \
'https://instance.service-now.com/api/now/cilifecyclemgmt/requestors/4cab9b95301a9010f877773aa7167ca9/valid' \
--header 'Accept: application/json' \
--user "username":"password"

{
  "result": {
    "result": true
  }
}

CI Lifecycle Management - GET /now/cilifecyclemgmt/statuses/{sys_id}

Returns the current operational state for the specified configuration item (CI).

URL format

Versioned URL: /api/now/{api_version}/cilifecyclemgmt/statuses/{sys_id}

Default URL: /api/now/cilifecyclemgmt/statuses/{sys_id}

Note: Available versions are specified in the REST API Explorer. For scripted REST APIs there is additional version information on the Scripted REST Service form.

Supported request parameters

Headers

The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Response body parameters (JSON or XML)

</td></tr><tr><td>

result.errors

</td><td>

List of objects in which each object represents an error encountered while processing the request.Data type: Array

 ```
"errors": [
  {
    "error": "String",
    "message": "String"
  }
]

cURL request

curl --request GET 'https://instance.service-now.com/api/now/cilifecyclemgmt/statuses/aac0b1213784200044e0bfc8bcbe5de3' \
--header 'Accept: application/json' \
--user "username":"password"

{
  "result": {
    "operationalState": "Repair in Progress",
    "result": true
  }
}

CI Lifecycle Management - PATCH /now/cilifecyclemgmt/leases/{sys_id}

Extends the specified configuration item (CI) action's lease expiration time for the specified user.

If the previous lease has expired, the new lease time starts immediately.

URL format

Versioned URL: /api/now/{api_version}/cilifecyclemgmt/leases/{sys_id}

Default URL: /api/now/cilifecyclemgmt/leases/{sys_id}

Note: Available versions are specified in the REST API Explorer. For scripted REST APIs there is additional version information on the Scripted REST Service form.

Supported request parameters

Headers

The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Response body parameters (JSON or XML)

</td></tr><tr><td>

result.errors

</td><td>

List of objects in which each object represents an error encountered while processing the request.Data type: Array

 ```
"errors": [
  {
    "error": "String",
    "message": "String"
  }
]

cURL request

Extend the duration of a Patching CI action requestor lease by 24 hours.

curl --request PATCH 'https://instance.service-now.com/api/now/cilifecyclemgmt/leases/affd3c8437201000deeabfc8bcbe5dc3?actionName=Patching&leaseTime=24:00:00&requestorId=e7c3402d305a9010f877773aa7167c2a' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--user "username":"password"

{
  "result": {
    "result": true
  }
}

CI Lifecycle Management - POST /now/cilifecyclemgmt/actions

Adds a specified configuration item (CI) action to a specified list of CIs.

URL format

Versioned URL: /api/now/{api_version}/cilifecyclemgmt/actions

Default URL: /api/now/cilifecyclemgmt/actions

Note: Available versions are specified in the REST API Explorer. For scripted REST APIs there is additional version information on the Scripted REST Service form.

Supported request parameters

Headers

The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Response body parameters (JSON or XML)

</td></tr><tr><td>

result.errors

</td><td>

List of objects in which each object represents an error encountered while processing the request.Data type: Array

 ```
"errors": [
  {
    "error": "String",
    "message": "String"
  }
]

cURL request

Add a Patching CI action to two CIs.

curl --request POST \
"https://instance.service-now.com/api/now/cilifecyclemgmt/actions?actionName=Patching&requestorId=621b5a09309e5010f877773aa7167c0a&sysIds=00a9a80d3790200044e0bfc8bcbe5d1c,d0fdbc8437201000deeabfc8bcbe5d33" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username":"password"

{
  "result": {
    "result": true
  }
}

CI Lifecycle Management - POST /now/cilifecyclemgmt/operators

Registers an operator for a non-workflow user.

URL format

Versioned URL: /api/now/{api_version}/cilifecyclemgmt/operators

Default URL: /api/now/cilifecyclemgmt/operators

Note: Available versions are specified in the REST API Explorer. For scripted REST APIs there is additional version information on the Scripted REST Service form.

Supported request parameters

Headers

The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Response body parameters (JSON or XML)

</td></tr><tr><td>

result.errors

</td><td>

List of objects in which each object represents an error encountered while processing the request.Data type: Array

 ```
"errors": [
  {
    "error": "String",
    "message": "String"
  }
]

cURL request

curl --request POST \
"https://instance.service-now.com/api/now/cilifecyclemgmt/operators" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username":"password"

{
  "result": {
    "result": true,
    "requestorId": "6f992b8430121010f877773aa7167c42"
  }
}

CI Lifecycle Management - POST /now/cilifecyclemgmt/statuses

Sets the operational state for a specified list of configuration items (CIs).

URL format

Versioned URL: /api/now/{api_version}/cilifecyclemgmt/statuses

Default URL: /api/now/cilifecyclemgmt/statuses

Note: Available versions are specified in the REST API Explorer. For scripted REST APIs there is additional version information on the Scripted REST Service form.

Supported request parameters

Headers

The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Response body parameters (JSON or XML)

</td></tr><tr><td>

result.errors

</td><td>

List of objects in which each object represents an error encountered while processing the request.Data type: Array

 ```
"errors": [
  {
    "error": "String",
    "message": "String"
  }
]

cURL request

Set the Repair in Progress operational state for two CIs.

curl --request POST \
"https://instance.service-now.com/api/now/cilifecyclemgmt/statuses?opsLabel=Repair%20in%20Progress&requestorId=23d58bc030121010f877773aa7167c83&sysIds=affd3c8437201000deeabfc8bcbe5dc3,aac0b1213784200044e0bfc8bcbe5de3" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username":"password"

The response body shows that the desired operational state was set for both CIs specified in the request.

{
  "result": {
    "result": true
  }
}