REST API reference › API reference › API implementation and reference

Release: Australia · Updated: 2026-03-12 · Official documentation · View source

Cloud Services Catalog API

The Cloud Services Catalog API provides methods related to Day-1 (provisioning) and Day-2 (modification) operations available in the Cloud Services Catalog, such as creating cloud service stacks and calling resource operation requests. You can also retrieve information about catalog requests, stacks getting status, and other information.

This API is included in the now namespace and requires the sn_cmp.cloud_service_user role. The Cloud Services Catalog (CSC) application is available as a separate subscription and requires either the ITOM Enterprise bundle or ITOM Cloud Accelerate product Entitlement.

The Cloud Services Catalog API features actions you perform during Day 2 operations. In the context of this API, resource catalog items refer to catalog items related to Day 2 operations.

To use this API, ensure that you have completed the Cloud Services Catalog guided setup process or have a working configuration where provisioning and catalog operations are working in the UI. For more information about these steps, see Cloud Services Catalog.

Parent Topic:REST API reference

Cloud Services Catalog - GET /now/cmp_catalog_api/itemsbyciclass

Returns a list of resource catalog items based on a given configuration item (CI) class.

URL format

Default URL: /api/now/cmp_catalog_api/itemsbyciclass

Supported request parameters

Name	Description
None

Name	Description
ci\_class	Required. Name of the CI class to get the resource catalog items from \(for example, "cmdb\_ci\_vm\_instance"\). Located in the Reference CI Type field in the Configuration Item \[cmdb\_ci\] table.Data type: String
display\_variables	Flag that indicates whether to list catalog item variables associated with each catalog item.Valid values: - true: Displays list catalog item variables. - false: Doesn't display list catalog item variables. Data type: Boolean Default: False
operation\_name	Optional. Name of the operation. Located in the Name column of the resource interface in the OperationSignature [sn_cmp_rb_op_signature] table.Note: This parameter can query part or whole of the operation. For example, if you want to list all interfaces starting with "Servicenow", you can set the variable as `operation_name = Servicenow`. Default: All catalog items of all operation types are returned. Data type: String
resource\_interface	Optional. Resource interface that the resource catalog item is hosted on. Located in the Name column of the ResourceInterfaces \[sn\_cmp\_rb\_resourceinterface\] table.Data type: String

Name	Description
None

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.

Header	Description
Accept	Data format of the response body. Supported types: application/json or application/xml. Default: application/json

Header	Description
None

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.

Status code	Description
200	Successful. The request was successfully processed.
400	Bad Request. A bad request type or malformed request was detected.
401	Unauthorized. The user credentials are incorrect or have not been passed.
403	Forbidden. The user doesn't have access rights to the specified record.
404	Not found. The requested item wasn't found.
405	Invalid method. The functionality is disabled.
500	Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.

Response body parameters (JSON or XML)

Name	Description
active	Active state of the resource operation catalog item. Possible values: - true: The resource operation catalog item is active. - false: The resource operation catalog item is inactive. Data type: String
created\_on	Time stamp from when the resource operation catalog item was created. Format: yyyy-MM-dd HH:mm:ss. Data type: String
display\_name	Name of the resource interface. Located in the ResourceInterfaces \[sn\_cmp\_rb\_resourceinterface\] table.Data type: String
id	Sys\_id of the resource operation catalog item.Data type: String Table: Resource Operation Catalog Item \[sn\_cmp\_rsrc\_opr\_cat\_item\]
name	Name of the resource operation catalog item. Located in the Resource Operation Catalog Item \[sn\_cmp\_rsrc\_opr\_cat\_item\] table.Data type: String
short\_description	Brief description of the resource operation catalog item.Data type: String Table: Resource Operation Catalog Item \[sn\_cmp\_rsrc\_opr\_cat\_item\]
updated\_on	Time stamp from when the resource operation catalog item was last updated. Required format: yyyy-MM-dd HH:mm:ss.Data type: String

cURL request

The following example requests and returns the status of the request item.

curl "https://instance.servicenow.com/api/now/cmp_catalog_api/itemsbyciclass?ci_class=cmdb_ci_vm_instance&resource_interface=Virtual%20Machine%20Store%20Extension%20Interface&operation_name=Execute%20Job%20Template" \
--request GET \ 
--header 'Accept: application/json' \ 
--user 'username':'password'

Response:

[
  {
    "display_name": "Virtual Server-Virtual Machine Store Extension Interface-Execute Job Template",
    "id": "01b2341a56789012345d6ddeeff7b89fc",
    "created_on": "2019-04-28 12:58:26",
    "updated_on": "2019-04-28 12:58:26",
    "name": "Virtual Server-Virtual Machine Store Extension Interface-Execute Job Template",
    "short_description": "Catalog item to invoke operation",
    "active": true
  }
]

Cloud Services Catalog - GET /now/cmp_catalog_api/itemsbyrb

Returns a list of resource catalog items based on a given resource block.

URL format

Default URL: /api/now/cmp_catalog_api/itemsbyrb

Supported request parameters

Name	Description
None

Name	Description
display\_variables	Flag that indicates whether to list catalog item variables associated with each catalog item.Valid values: - true: Displays list catalog item variables. - false: Doesn't display list catalog item variables. Data type: Boolean Default: False
operation\_name	Optional. Name of the operation. Located in the Name column of the resource interface in the OperationSignature [sn_cmp_rb_op_signature] table.Note: This parameter can query part or whole of the operation. For example, if you want to list all interfaces starting with "Servicenow", you can set the variable as `operation_name = Servicenow`. Default: All catalog items of all operation types are returned. Data type: String
resource\_block	Required. Name of the resource block to get its related resource operation catalog items from \(for example, Virtual Server\).Default: All catalog items of all operation types are returned. Data type: String Table: Resource Block \[sn\_cmp\_rb\_resourceblock\]
resource\_interface	Optional. Resource interface that the resource catalog item is hosted on. Located in the Name column of the ResourceInterfaces \[sn\_cmp\_rb\_resourceinterface\] table.Data type: String

Name	Description
None

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.

Header	Description
Accept	Data format of the response body. Supported types: application/json or application/xml. Default: application/json

Header	Description
None

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.

Status code	Description
200	Successful. The request was successfully processed.
400	Bad Request. A bad request type or malformed request was detected.
401	Unauthorized. The user credentials are incorrect or have not been passed.
403	Forbidden. The user doesn't have access rights to the specified record.
404	Not found. The requested item wasn't found.
405	Invalid method. The functionality is disabled.
500	Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.

Response body parameters (JSON or XML)

Name	Description
active	Active state of the resource operation catalog item. Possible values: - true: The resource operation catalog item is active. - false: The resource operation catalog item is inactive. Data type: String
display\_name	Name of the resource interface. Located in the ResourceInterfaces \[sn\_cmp\_rb\_resourceinterface\] table.Data type: String
id	Sys\_id of the resource operation catalog item.Data type: String Table: Resource Operation Catalog Item \[sn\_cmp\_rsrc\_opr\_cat\_item\]
name	Name of the resource operation catalog item. Located in the Resource Operation Catalog Item \[sn\_cmp\_rsrc\_opr\_cat\_item\] table.Data type: String
short\_description	Brief description of the resource operation catalog item.Data type: String Table: Resource Operation Catalog Item \[sn\_cmp\_rsrc\_opr\_cat\_item\]
variables	List of extra details about the resource catalog item. The variables returned in this API vary based on the query parameters that were passed.Data type: Array of Objects `"variables": [ { "parameter1": "String", "parameter2": "String" } ]`

This example list of resource catalog items based on a Virtual Server resource block:

curl "https://instance.servicenow.com/api/now/cmp_catalog_api/itemsbyrb?resource_interface=Virtual%20Machine%20Store%20Extension%20Interface&operation_name=Execute%20Job%20Template&resource_block=Virtual%20Server" \
--request GET \ 
--header 'Accept: application/json' \ 
--user 'username':'password'

Response:

[
  {
    "display_name": "Virtual Server-Virtual Machine Store Extension Interface-Execute Job Template",
    "id": "01b2341a56789012345d6ddeeff7b89fc",
    "created_on": "2019-04-28 12:58:26",
    "updated_on": "2019-04-28 12:58:26",
    "name": "Virtual Server-Virtual Machine Store Extension Interface-Execute Job Template",
    "short_description": "Catalog item to invoke operation",
    "active": true
  }
]

Cloud Services Catalog - GET /now/cmp_catalog_api/services

Returns a list of catalog items based on the given blueprint of a Provision or Lifecycle catalog type.

URL format

Default URL: /api/now/cmp_catalog_api/services

Supported request parameters

Name	Description
None

Name Description

catalog\_type Optional. Type of catalog item. Accepted values \(case-sensitive\):- `Provision` - Returns all Blueprint type catalog items. - `LifeCycle` - Returns all Day 2 Operation type catalog items. If the input is empty \(default\), all services of both catalog types are returned. Data type: String

display\_variables Flag that indicates whether to list catalog item variables associated with each catalog item.Valid values: - true: Displays list catalog item variables. - false: Doesn't display list catalog item variables. Data type: Boolean Default: False

blueprint\_name

Optional. Name of the blueprint in which to fetch the related catalog items. Located in the Category Item [sn_cmp_bp_cat_item] table. Note: This parameter can query part or whole of the blueprint name. For example, if you want to list all blueprints starting with "Servicenow", you can set the variable as blueprint_name = Servicenow.

Default: all services of all blueprints are returned.

Data type: String

Name	Description
None

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.

Header	Description
Accept	Data format of the response body. Supported types: application/json or application/xml. Default: application/json

Header	Description
None

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.

Status code	Description
200	Successful. The request was successfully processed.
400	Bad Request. A bad request type or malformed request was detected.
401	Unauthorized. The user credentials are incorrect or have not been passed.
403	Forbidden. The user doesn't have access rights to the specified record.
404	Not found. The requested item wasn't found.
405	Invalid method. The functionality is disabled.
500	Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.

Response body parameters (JSON or XML)

Name	Description
active	Flag that indicates whether the catalog is active. Possible values: - true: Catalog is active. - false: Catalog isn't active. Data type: String
blueprint	Sys\_id of the blueprint.Data type: String Table: Blueprint \[sn\_cmp\_bp\_blueprint\]
blueprint\_category	Sys\_id of the blueprint category.Data type: String Table: Cloud Service Category \[sn\_capi\_service\_category\]
blueprint\_category\_name	Name of the blueprint category. Possible values: - Access - Analytics - Application Services - Blockchain - Business Productivity - Compute - Config Management - Containers - Database - Developer Tools - Event - Hybrid Cloud - IOT - IPAM - Loud Balancer - Machine Learning - Management Tools - Marketplace - Mobile - Network - Productivity - Security - Shell Access - Storage - Tools - Unknown - Virtual Reality Data type: String Table:Cloud Service Category \[sn\_capi\_service\_category\]
blueprint\_name	Name of the blueprint. Located in the Blueprint \[sn\_cmp\_bp\_blueprint\] table.Data type: String
blueprint\_type	Type of blueprint. Possible value: `Custom Blueprint` Data type: String
catalog\_name	Name of the catalog.Data type: String Table: Cloud Catalog Item \[sn\_cmp\_bp\_cat\_item\]
catalog\_type	Type of catalog. Possible values: - `1`: Catalog is of type provision. - `2`: Catalog is of type lifecycle. Data type: String
catalog\_type	Type of catalog. Possible values: - `1`: Catalog is of type provision. - `2`: Catalog is of type lifecycle. Data type: String
createdOn	Time stamp from when the catalog item was created. Data type: String
createdBy	User that created the catalog item.Data type: String
id	Sys\_id of the blueprint.Data type: String Table: Cloud Catalog Item \[sn\_cmp\_bp\_cat\_item\]
last\_updated\_on	Time stamp from when the catalog item was last updated. Data type: String
last\_updated\_by	User that last updated the catalog item, such as an admin or the system. Data type: String
operation	Sys\_id of the operation.Data type: String Table: OperationSignature \[sn\_cmp\_rb\_op\_signature\]
operation\_name	Name of the operation. Possible values: - Deprovision: Deletes resources with a terminated state and updates resource CMDB tables accordingly. - ModifyLease: Modifies the lease operation scheduled on provisioned resources. - ModifySchedule: Modifies the schedule for provisioned resources. - Start: Starts the resources that are in an off state. - Stop: Stops the resources that are in an on state. Data type: String
variables	Details about the list catalog item. The variables returned in this API vary based on the query parameters that are passed in the request.Data type: Array of Objects `"variables": [ { "parameter1": "String", "parameter2": "String" } ]`

This example returns all the catalog items of a Lifecycle type blueprint named "classiclb".

curl "https://instance.servicenow.comapi/now/cmp_catalog_api/services?display_variables=true&catalog_type=LifeCycle&blueprint_name=classiclb" \
--request GET \ 
--header 'Accept: application/json' \ 
--user 'username':'password'

Response:

[
  {
    "catalog_name": "Deprovision",
    "blueprint": "d90d9d80476c46104bf15222516d43b9",
    "blueprint_name": "classiclb",
    "blueprint_category": "57c0dbd9934b22004a9032bfa67ffb79",
    "active": true,
    "category": "86d85478678232005ca552e457415a79",
    "blueprint_category_name": "Compute",
    "shortDescription": "Are you sure you want to perform this operation?",
    "id": "01b2341a56789012345d6ddeeff7b89fc",
    "variables": [
      {
        "id": "a12d34c5678c91234bf45678912d34e4",
        "name": "StackID",
        "question_text": "StackID",
        "default_value": "Not specified"
      }
    ],
    "last_updated_on": "2024-02-19 07:46:03",
    "last_updated_by": "system",
    "catalog_type": "2",
    "created_on": "2024-02-19 07:46:02",
    "created_by": "user@password.com",
    "operation": "a70d51c0476c46104bf15222516d4375",
    "blueprint_type": "Custom Blueprint",
    "operation_name": "Deprovision"
  },
  {
    "catalog_name": "ModifySchedule",
    "blueprint": "d90d9d80476c46104bf15222516d43b9",
    "blueprint_name": "classiclb",
    "blueprint_category": "57c0dbd9934b22004a9032bfa67ffb79",
    "active": true,
    "category": "86d85478678232005ca552e457415a79",
    "blueprint_category_name": "Compute",
    "shortDescription": null,
    "id": "361d55c0476c46104bf15222516d4351",
    "variables": [
      {
        "id": "031d55c0476c46104bf15222516d43af",
        "name": "ScheduleProfile",
        "question_text": "ScheduleProfile",
        "default_value": "Not specified"
      },
      {
        "id": "0b1d55c0476c46104bf15222516d43c9",
        "name": "ScheduleTimeZone",
        "question_text": "ScheduleTimeZone",
        "default_value": "Not specified"
      }
    ],
    "last_updated_on": "2024-02-19 07:45:53",
    "last_updated_by": "system",
    "catalog_type": "2",
    "created_on": "2024-02-19 07:45:52",
    "created_by": "user@password.com",
    "operation": "130d51c0476c46104bf15222516d436c",
    "blueprint_type": "Custom Blueprint",
    "operation_name": "ModifySchedule"
  },
  {
    "catalog_name": "Stop",
    "blueprint": "d90d9d80476c46104bf15222516d43b9",
    "blueprint_name": "classiclb",
    "blueprint_category": "57c0dbd9934b22004a9032bfa67ffb79",
    "active": true,
    "category": "86d85478678232005ca552e457415a79",
    "blueprint_category_name": "Compute",
    "shortDescription": "Are you sure you want to perform this operation?",
    "id": "542dd5c0476c46104bf15222516d43b0",
    "variables": [
      {
        "id": "a02d19c0476c46104bf15222516d4301",
        "name": "StackID",
        "question_text": "StackID",
        "default_value": "Not specified"
      }
    ],
    "last_updated_on": "2024-02-19 07:46:00",
    "last_updated_by": "system",
    "catalog_type": "2",
    "created_on": "2024-02-19 07:45:58",
    "created_by": "user@password.com",
    "operation": "930d51c0476c46104bf15222516d436f",
    "blueprint_type": "Custom Blueprint",
    "operation_name": "Stop"
  },
  {
    "catalog_name": "Cleanup",
    "blueprint": "d90d9d80476c46104bf15222516d43b9",
    "blueprint_name": "classiclb",
    "blueprint_category": "57c0dbd9934b22004a9032bfa67ffb79",
    "active": true,
    "category": "86d85478678232005ca552e457415a79",
    "blueprint_category_name": "Compute",
    "shortDescription": "Are you sure you want to perform this operation?",
    "id": "712d59c0476c46104bf15222516d435c",
    "variables": [
      {
        "id": "da2d59c0476c46104bf15222516d43dc",
        "name": "resourceId",
        "question_text": "ResourceId",
        "default_value": "Not specified"
      },
      {
        "id": "da2d59c0476c46104bf15222516d43e2",
        "name": "operationName",
        "question_text": "OperationName",
        "default_value": "Not specified"
      }
    ],
    "last_updated_on": "2024-02-19 07:46:06",
    "last_updated_by": "system",
    "catalog_type": "2",
    "created_on": "2024-02-19 07:46:04",
    "created_by": "user@password.com",
    "operation": "ab0d51c0476c46104bf15222516d437b",
    "blueprint_type": "Custom Blueprint",
    "operation_name": "Cleanup"
  },
  {
    "catalog_name": "ModifyLease",
    "blueprint": "d90d9d80476c46104bf15222516d43b9",
    "blueprint_name": "classiclb",
    "blueprint_category": "57c0dbd9934b22004a9032bfa67ffb79",
    "active": true,
    "category": "86d85478678232005ca552e457415a79",
    "blueprint_category_name": "Compute",
    "shortDescription": null,
    "id": "bb1dd5c0476c46104bf15222516d4301",
    "variables": [
      {
        "id": "142dd5c0476c46104bf15222516d4382",
        "name": "resourceId",
        "question_text": "ResourceId",
        "default_value": "Not specified"
      },
      {
        "id": "d82dd5c0476c46104bf15222516d4394",
        "name": "operationName",
        "question_text": "OperationName",
        "default_value": "Not specified"
      }
    ],
    "last_updated_on": "2024-02-19 07:45:58",
    "last_updated_by": "system",
    "catalog_type": "2",
    "created_on": "2024-02-19 07:45:56",
    "created_by": "user@password.com",
    "operation": "2b0d51c0476c46104bf15222516d4378",
    "blueprint_type": "Custom Blueprint",
    "operation_name": "ModifyLease"
  },
  {
    "catalog_name": "Start",
    "blueprint": "d90d9d80476c46104bf15222516d43b9",
    "blueprint_name": "classiclb",
    "blueprint_category": "57c0dbd9934b22004a9032bfa67ffb79",
    "active": true,
    "category": "86d85478678232005ca552e457415a79",
    "blueprint_category_name": "Compute",
    "shortDescription": "Are you sure you want to perform this operation?",
    "id": "d71d95c0476c46104bf15222516d4312",
    "variables": [
      {
        "id": "731d95c0476c46104bf15222516d43ae",
        "name": "resourceId",
        "question_text": "ResourceId",
        "default_value": "Not specified"
      },
      {
        "id": "731d95c0476c46104bf15222516d43b4",
        "name": "operationName",
        "question_text": "OperationName",
        "default_value": "Not specified"
      }
    ],
    "last_updated_on": "2024-02-19 07:45:55",
    "last_updated_by": "system",
    "catalog_type": "2",
    "created_on": "2024-02-19 07:45:54",
    "created_by": "user@password.com",
    "operation": "270d51c0476c46104bf15222516d4372",
    "blueprint_type": "Custom Blueprint",
    "operation_name": "Start"
  }
]

Cloud Services Catalog - GET /now/cmp_catalog_api/stacks

Returns a list of catalog items based on Provision-type blueprints (also known as stacks).

URL format

Default URL: /api/now/cmp_catalog_api/stacks

Supported request parameters

Name	Description
None

Name Description

blueprint\_name

Optional. Name of the blueprint in which to fetch the related catalog items. Located in the Category Item [sn_cmp_bp_cat_item] table. Note: This parameter can query part or whole of the blueprint name. For example, if you want to list all blueprints starting with "Servicenow", you can set the variable as blueprint_name = Servicenow.

Default: all services of all blueprints are returned.

Data type: String

display\_variables Flag that indicates whether to list catalog item variables associated with each catalog item.Valid values: - true: Displays list catalog item variables. - false: Doesn't display list catalog item variables. Data type: Boolean Default: False

Name	Description
None

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.

Header	Description
Accept	Data format of the response body. Supported types: application/json or application/xml. Default: application/json

Header	Description
None

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.

Status code	Description
200	Successful. The request was successfully processed.
400	Bad Request. A bad request type or malformed request was detected.
401	Unauthorized. The user credentials are incorrect or have not been passed.
403	Forbidden. The user doesn't have access rights to the specified record.
404	Not found. The requested item wasn't found.
405	Invalid method. The functionality is disabled.
500	Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.

Response body parameters (JSON or XML)

Name	Description
active	Flag that indicates whether the catalog is active. Possible values: - true: Catalog is active. - false: Catalog isn't active. Data type: String
blueprint	Sys\_id of the blueprint.Data type: String Table: Blueprint \[sn\_cmp\_bp\_blueprint\]
blueprint\_category	Sys\_id of the blueprint category.Data type: String Table: Cloud Service Category \[sn\_capi\_service\_category\]
blueprint\_category\_name	Name of the blueprint category. Possible values: - Access - Analytics - Application Services - Blockchain - Business Productivity - Compute - Config Management - Containers - Database - Developer Tools - Event - Hybrid Cloud - IOT - IPAM - Loud Balancer - Machine Learning - Management Tools - Marketplace - Mobile - Network - Productivity - Security - Shell Access - Storage - Tools - Unknown - Virtual Reality Data type: String Table:Cloud Service Category \[sn\_capi\_service\_category\]
blueprint\_name	Name of the blueprint. Located in the Blueprint \[sn\_cmp\_bp\_blueprint\] table.Data type: String
blueprint\_type	Type of blueprint. Possible value: `Custom Blueprint` Data type: String
catalog\_name	Name of the catalog.Data type: String Table: Cloud Catalog Item \[sn\_cmp\_bp\_cat\_item\]
catalog\_type	Type of catalog. Possible values: - `1`: Catalog is of type provision. - `2`: Catalog is of type lifecycle. Data type: String
catalog\_type\_name	Name of the catalog type.Possible values: - Provision Operation \(Day 1\): Catalog type is named provision. - LifeCycle Operation \(Day 2\): Catalog type is named lifecycle. Data type: String
id	Sys\_id of the blueprint.Data type: String Table: Cloud Catalog Item \[sn\_cmp\_bp\_cat\_item\]
lifecycleOperations	Object containing the life cycle operation's name and sys\_id.Date type: Array of Objects `"lifecycleOperations": [ { "id": "String", "name": "String" }`
lifecycleOperations.id	Sys\_id of the life cycle operation.Data type: String Table: OperationSignature \[sn\_cmp\_rb\_op\_signature\]
lifeCycleOperations.name	Type of life cycle operations. Possible values: - Cleanup: Cleans up resources with a terminated state. - Deprovision: Deletes resources in a terminated state and updates resource CMDB tables accordingly. - ModifyLease: Modifies the lease operation scheduled on provisioned resources. - ModifySchedule: Performs business hours scheduling on stacks at the time of provisioning or on existing stacks. - Start: Starts the resources that are in an off state. - Stop: Stops the resources that are in an on state. Date type: Object
operation	Sys\_id of the operation.Data type: String Table: OperationSignature \[sn\_cmp\_rb\_op\_signature\]
operation\_name	Name of the operation. Possible values: - Deprovision: Deletes resources with a terminated state and updates resource CMDB tables accordingly. - ModifyLease: Modifies the lease operation scheduled on provisioned resources. - ModifySchedule: Modifies the schedule for provisioned resources. - Start: Starts the resources that are in an off state. - Stop: Stops the resources that are in an on state. Data type: String
shortDescription	Brief description of the catalog.Data type: String
template\_name	Name of the template.Data type: String Table: Cloud Catalog Item \[sn\_cmp\_bp\_cat\_item\]
template\_type	Sys\_id of the template type.Data type: String Table: Cloud Catalog Item \[sn\_cmp\_bp\_cat\_item\]
template\_cloud\_product\_name	Name of the product.Data type: String Table: Cloud Catalog Item \[sn\_cmp\_bp\_cat\_item\]
variables	Details about the list catalog item. The variables returned in this API vary based on the query parameters that are passed in the request.Data type: Array of Objects `"variables": [ { "parameter1": "String", "parameter2": "String" } ]`

The following example returns all catalog items in the instance with the provision catalog type.

curl "https://instance.servicenow.com/api/now/cmp_catalog_api/stacks" \
--request GET \ 
--header 'Accept: application/json' \ 
--user 'username':'password'

Return:

[
  {
    "catalog_type": "1",
    "catalog_type_name": "Provision Operation (Day 1)",
    "catalog_name": "classiclb",
    "blueprint": "d90d9d80476c46104bf15222516d43b9",
    "blueprint_name": "classiclb",
    "blueprint_category": "57c0dbd9934b22004a9032bfa67ffb79",
    "blueprint_category_name": "Compute",
    "active": true,
    "category": "8641fe260b212200eff7ef9bb4673a3d",
    "shortDescription": null,
    "id": "07cc9580476c46104bf15222516d43c3",
    "last_updated_on": "2024-02-19 07:46:13",
    "last_updated_by": "user@servicenow.com",
    "blueprint_type": "Cloud Template",
    "template_type": "932f81e49f00320048111f80a57fcf6e",
    "template_name": "CloudFormation Template",
    "template_cloud_product": "52cfc4749f00320048111f80a57fcf9a",
    "template_cloud_product_name": "AWS CloudFormation",
    "lifecycleOperations": [
      {
        "id": "1d2d19c0476c46104bf15222516d4392",
        "name": "Deprovision"
      },
      {
        "id": "361d55c0476c46104bf15222516d4351",
        "name": "ModifySchedule"
      },
      {
        "id": "542dd5c0476c46104bf15222516d43b0",
        "name": "Stop"
      },
      {
        "id": "712d59c0476c46104bf15222516d435c",
        "name": "Cleanup"
      },
      {
        "id": "bb1dd5c0476c46104bf15222516d4301",
        "name": "ModifyLease"
      },
      {
        "id": "d71d95c0476c46104bf15222516d4312",
        "name": "Start"
      }
    ],
    "created_on": "2024-02-19 07:44:44",
    "created_by": "user@servicenow.com",
    "operation": "130d51c0476c46104bf15222516d4368",
    "operation_name": "Provision"
  }
]

Cloud Services Catalog - GET /now/cmp_catalog_api/status

Returns the status and details of a given catalog RITM (request item).

Use this method to identify and trace the request's origin and monitor its flow. The response includes the following:

RITM number for the submitted request
The stage the request is in
The users who opened and is assigned the request
The group assigned to the request
When the request was opened
The state the request is in
Submission data

URL format

Default URL: /api/now/cmp_catalog_api/status

Supported request parameters

Name	Description
None

Name	Description
req\_item	Unique request item number in the Requested Item \[sc\_req\_item\] table. For example, `RITM0000001`.Data type: String

Name	Description
None

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.

Header	Description
Accept	Data format of the response body. Supported types: application/json or application/xml. Default: application/json

Header	Description
None

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.

Status code	Description
200	Successful. The request was successfully processed.
400	Bad Request. A bad request type or malformed request was detected.
401	Unauthorized. The user credentials are incorrect or have not been passed.
403	Forbidden. The user doesn't have access rights to the specified record.
404	Not found. The requested item wasn't found.
405	Invalid method. The functionality is disabled.
500	Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.

Response body parameters (JSON or XML)

Name	Description
assignmentGroup	Group assigned to the request.Data type: String
assignedTo	User email assigned to the request.Data type: String
catItem	Sys\_id of the catalog item request.Data type: String Table: Cloud Catalog Item \[sn\_cmp\_bp\_cat\_item\]
error	Message with details about a returned error. Possible error messages: - Record Not Found: The request item doesn't exist. - User Not Authenticated: The user's credentials aren't authorized to make this request. Data type: String
number	Unique Request Item Number \(RITM\) given to the new request item.Data type: String Table: Request Item \[sc\_req\_item\]
openedAt	Time stamp from when the request item was opened. Format: yyyy-MM-dd HH:mm:ss. Date type: String
openedBy	Sys\_id of the user who opened the request.Data type: String
stage	Current processing stage of the request item. Possible values: - Deploying Stack - Deployment Cancelled - Deployment Failed - Deployment Successful - Resource Limit Exceeded - Retrying Stack Deployment - Task Created for User - Waiting for Provision Approval Data type: String
state	Current completion state of the request item.Possible values: - Closed Complete - Closed Incomplete - Closed Skipped - Open - Pending - Work in Progress Data type: String
submissionData	Information about the request submission, like cloud account, location, application, and cost center data. Submission data varies depending on the request item number passed in the request.Data type: Object `"submissionData": "{\"key1\":\"value\", \"key2\":\"value\"}" }`
sys\_id	Sys\_id of the request item record.Data type: String Table: Request Item \[sc\_req\_item\]

cURL request

The following example returns status information for the request item number, RITM0010076.

curl "https://instance.servicenow.com/api/now/cmp_catalog_api/statusreq_item=RITM0010076" \
--request GET \ 
--header 'Accept: application/json' \ 
--user 'username':'password'

Response:

{ 
  "catItem": "39737024c390719005091d75e0013115", 
  "stage": "Task Created for User", 
  "sys_id": "ee1197db476cc2904bf15222516d439f", 
  "assignedTo": null, 
  "assignmentGroup": null, 
  "number": "RITM0010072", 
  "openedAt": "2024-02-29 18:32:55", 
  "openedBy": "6816f79cc0a8016401c5a33be04be441", 
  "state": "Open", 
  "submissionData": "{\"CloudAccount\":\"AzureCA\",\"CSC_Azure_Functions_newResourceGroup\":\"test-rg-dnd\",\"CSC_Azure_Functions_runTimeVersion\":\"~18\",\"CSC_Azure_Functions_runTimeEngine\":\"node\",\"CSC_Azure_Functions_os\":\"Windows\",\"CSC_Azure_Functions_functionAppName\":\"sa02291029-fa\",\"LeaseEndDate\":\"2024-05-29 17:29:57\",\"ScheduleProfile\":\"-- No Schedule --\",\"UserGroup\":\"cfcbad03d711110050f5edcb9e61038f\",\"CSC_Azure_Functions_applicationName\":\"function-app\",\"ScheduleTimeZone\":\"America/Los_Angeles\",\"BusinessService\":\"\",\"environment\":\"Production\",\"CostCenter\":\"\",\"UseExistingWorkspace\":false,\"CSC_Azure_Functions_existingResourceGroup\":\"cpg-dnd\",\"CSC_Azure_Functions_isNewResourceGroup\":\"false\",\"CSC_Azure_Functions_storageAccountName\":\"sa02291029fasa\",\"Application\":\"\",\"StackName\":\"sa02291029\",\"Location\":\"Azure Datacenter - eastus\",\"Workspace\":\"\"}" 
}

Cloud Services Catalog - POST /now/cmp_catalog_api/submitoprequest

Submits a resource operation request to perform day 2 operations on provisioned resources.

URL format

Default URL: /api/now/cmp_catalog_api/submitoprequest

Supported request parameters

Name	Description
None

Name	Description
cat\_id	Required. sys\_id of the cloud catalog item to invoke. Available in the Cloud Catalog Item \[sn\_cmp\_bp\_cat\_item\] table.Data type: String

Name	Description
CloudAccount	Required. Name of the cloud account in which to submit the request. Account names are available in the Cloud Account \[cmdb\_ci\_cmp\_cloud\_account\] table.Data type: String
Location	Required. Datacenter location in which to provision the resource. For example, `us-west-1` or `asia-south-2`. This value should match the datacenter location of the cloud account's platform provider. Available in the Associated Datacenter \[sn\_cmp\_ca\_assc\_datacenter\] table. Data type: String
StackName	Required. Name of the stack. The stack name is dynamic and is reflected in resource management.Data type: String
resourceId	Required. Sys\_id of the resource where Day 2 operations will be performed.Data type: String Table: Stack Items \[sn\_cmp\_stack\_item\]
resource\_block	Required. Name of the resource block to get its related resource operation catalog items from \(for example, Virtual Server\).Default: All catalog items of all operation types are returned. Data type: String Table: Resource Block \[sn\_cmp\_rb\_resourceblock\]
operation\_name	Optional. Name of the operation. Located in the Name column of the resource interface in the OperationSignature [sn_cmp_rb_op_signature] table. The operation name you enter depends on the value passed in the resourceBlock parameter.Note: This parameter can query part or whole of the operation. For example, if you want to list all interfaces starting with "Servicenow", you can set the variable as `operation_name = Servicenow`. Default: All catalog items of all operation types are returned.Data type: String
resourceInterface	Required. Name of the resource block to get its related resource operation catalog items from (for example, Virtual Server). The resource interface you enter depends on the value passed in the resourceBlock and operation_name parameters.Default: All catalog items of all operation types are returned. Data type: String

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.

Header	Description
Accept	Data format of the response body. Supported types: application/json or application/xml. Default: application/json

Header	Description
None

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.

Status code	Description
200	Successful. The request was successfully processed.
400	Bad Request. A bad request type or malformed request was detected.
401	Unauthorized. The user credentials are incorrect or have not been passed.
403	Forbidden. The user doesn't have access rights to the specified record.
404	Not found. The requested item wasn't found.
405	Invalid method. The functionality is disabled.
500	Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.

Response body parameters (JSON or XML)

Name	Description
assignmentGroup	Group assigned to the request.Data type: String
assignedTo	User email assigned to the request.Data type: String
catItem	Sys\_id of the catalog item request.Data type: String Table: Cloud Catalog Item \[sn\_cmp\_bp\_cat\_item\]
number	Unique Request Item Number \(RITM\) given to the new request item.Data type: String Table: Request Item \[sc\_req\_item\]
openedAt	Time stamp from when the request item was opened. Format: yyyy-MM-dd HH:mm:ss. Date type: String
openedBy	Sys\_id of the user who opened the request.Data type: String
stage	Current processing stage of the request item. Possible values: - Deploying Stack - Deployment Cancelled - Deployment Failed - Deployment Successful - Resource Limit Exceeded - Retrying Stack Deployment - Task Created for User - Waiting for Provision Approval Data type: String
state	Current completion state of the request item.Possible values: - Closed Complete - Closed Incomplete - Closed Skipped - Open - Pending - Work in Progress Data type: String
submissionData	Information about the request submission, like cloud account, location, application, and cost center data. Submission data varies depending on the request item number passed in the request.Data type: Object `"submissionData": "{\"key1\":\"value\", \"key2\":\"value\"}" }`
sys\_id	Sys\_id of the request item record.Data type: String Table: Request Item \[sc\_req\_item\]

The following example creates a Day 2 operation request item.

curl "https://instance.servicenow.com/api/now/cmp_catalog_api/submitoprequest?cat_id=e44dcd238731e5101126cbb4dabb3506" /
--request POST\ 
--header 'Accept: application/json' \ 
--user 'username':'password'

//Request body:
{"StackName":"sa02292143","CloudAccount":"AWS","Location":"AWS Datacenter - us-east-1","resourceId":"df8c61e3eb2cc210d298fbbdbad0cd74","operationName":"Deprovision","resourceInterface":"S3 Interface","resourceBlock":"S3"}

Response body:

{ 
  "number": "RITM0010078", 
  "catItem": "e44dcd238731e5101126cbb4dabb3506", 
  "stage": "request_approved", 
  "sys_id": "9bf5cab3c3594610bc89b33605013190", 
  "assignedTo": null, 
  "assignmentGroup": null, 
  "openedAt": "2024-04-08 09:08:47", 
  "openedBy": "6816f79cc0a8016401c5a33be04be441", 
  "state": "Open", 
  "submissionData": "{\"StackName\":\"sa02292143\",\"CloudAccount\":\"AWS\",\"Location\":\"AWS Datacenter - us-east-1\",\"resourceId\":\"df8c61e3eb2cc210d298fbbdbad0cd74\",\"operationName\":\"Deprovision\",\"resourceInterface\":\"S3 Interface\",\"resourceBlock\":\"S3\"}" 
} 

Sample Request Body for CSC S3 Bucket Catalog Order: 

{"StackName":"sa02292143","CloudAccount":"AWS","Location":"AWS Datacenter - us-east-1","resourceId":"df8c61e3eb2cc210d298fbbdbad0cd74","operationName":"Deprovision","resourceInterface":"S3 Interface","resourceBlock":"S3"}

Cloud Services Catalog - POST /now/cmp_catalog_api/submitrequest

Submits a cloud services request. This method accepts provisioned requests for both day 2 operations and stacks or resource operation catalog items.

URL format

Default URL: /api/now/cmp_catalog_api/submitrequest

Supported request parameters

Name	Description
None

Name	Description
cat\_id	Required. sys\_id of the cloud catalog item to invoke. Available in the Cloud Catalog Item \[sn\_cmp\_bp\_cat\_item\] table.Data type: String

Name	Description
CloudAccount	Required. Name of the cloud account in which to submit the request. Account names are available in the Cloud Account \[cmdb\_ci\_cmp\_cloud\_account\] table.Data type: String
Location	Required. Datacenter location in which to provision the resource. For example, `us-west-1` or `asia-south-2`. This value should match the datacenter location of the cloud account's platform provider. Available in the Associated Datacenter \[sn\_cmp\_ca\_assc\_datacenter\] table. Data type: String
StackName	Required. Name of the stack. The stack name is dynamic and is reflected in resource management.Data type: String

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.

Header	Description
Accept	Data format of the response body. Supported types: application/json or application/xml. Default: application/json

Header	Description
None

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.

Status code	Description
200	Successful. The request was successfully processed.
400	Bad Request. A bad request type or malformed request was detected.
401	Unauthorized. The user credentials are incorrect or have not been passed.
403	Forbidden. The user doesn't have access rights to the specified record.
404	Not found. The requested item wasn't found.
405	Invalid method. The functionality is disabled.
500	Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.

Response body parameters (JSON or XML)

Name	Description
assignmentGroup	Group assigned to the request.Data type: String
assignedTo	User email assigned to the request.Data type: String
catItem	Sys\_id of the catalog item request.Data type: String Table: Cloud Catalog Item \[sn\_cmp\_bp\_cat\_item\]
number	Unique Request Item Number \(RITM\) given to the new request item.Data type: String Table: Request Item \[sc\_req\_item\]
openedAt	Time stamp from when the request item was opened. Format: yyyy-MM-dd HH:mm:ss. Date type: String
openedBy	Sys\_id of the user who opened the request.Data type: String
stage	Current processing stage of the request item. Possible values: - Deploying Stack - Deployment Cancelled - Deployment Failed - Deployment Successful - Resource Limit Exceeded - Retrying Stack Deployment - Task Created for User - Waiting for Provision Approval Data type: String
state	Current completion state of the request item.Possible values: - Closed Complete - Closed Incomplete - Closed Skipped - Open - Pending - Work in Progress Data type: String
submissionData	Information about the request submission, like cloud account, location, application, and cost center data. Submission data varies depending on the request item number passed in the request.Data type: Object `"submissionData": "{\"key1\":\"value\", \"key2\":\"value\"}" }`
sys\_id	Sys\_id of the request item record.Data type: String Table: Request Item \[sc\_req\_item\]

The following example submits a cloud resource request in the instance's AWS Cloud Account.

curl "https://instance.servicenow.com/api/now/cmp_catalog_api/submitrequest?cat_id=022e3deec3122910a769f44ed40131b9" /
--request POST \ 
--header 'Accept: application/json' \ 
--user 'username':'password'

//Request body:
{"CloudAccount":"AWS","Location":"us-east-1","StackName":"ss"}

Response:

{ 
  "number": "RITM0010001", 
  "catItem": "022e3deec3122910a769f44ed40131b9", 
  "stage": "check_permissions", 
  "sys_id": "86d34233c3594610bc89b336050131dd", 
  "assignedTo": null, 
  "assignmentGroup": null, 
  "openedAt": "2024-04-08 08:59:25", 
  "openedBy": "6816f79cc0a8016401c5a33be04be441", 
  "state": "Open", 
  "submissionData": "{\"CloudAccount\":\"AWS\",\"Location\":\"us-east-1\",\"StackName\":\"ss\"}" 
}