Skip to main content

Check out Interactive Visual Stories to gain hands-on experience with the SSE product features. Click here.

Skyhigh Security

Retrieve Information for Multiple Services

Use this API call to request information on more than one service at once.

URI for Request

/rest/clientapi/csp/bulk

Method

POST

Acceptable Request Body

To Retrieve Service Details by Service ID 

  1. Send a Post request to /rest/clientapi/csp/bulk.
  2. Enter the serviceIDs of the selected service for the serviceid parameter, separated by a comma.
  3. Enter keythatidentifiesthepartner for the apikey parameter.
  4. Enter serviceid for the queryby parameter.
{"serviceids": [2154,12345], "apikey" : "keythatidentifiesthepartner","queryby":"serviceid",
"attributemetadata":"false"}

To Retrieve Service Details by Service Name 

  1. Send a Post request  to /rest/clientapi/csp/.
  2. Enter the names of the service for the servicename parameter, separated by a comma.
  3. Enter keythatidentifiesthepartner for the apikey parameter.
  4. Enter servicename for the queryby parameter.
{"servicename" : "Example Service", "apikey" : "keythatidentifiesthepartner", "queryby":"servicename", 
"attributemetadata":"true" }

Required Parameters 

  • serviceID. The ID number of the cloud service. This can be determined my making a call to the Registry API.
  • servicename.The name of the cloud service, as it appears in the Global Registry.
  • apikey. The security API key provided to you during API setup.
    • In examples, keythatidentifiesthepartner is the placeholder for the API key provided to you by support during initial API setup.
  • queryby. The method used to query the registry.
    • servicename. Used to query the API by the name of the cloud service.
    • serviceid. Used to query the API by the internal Service ID.

Optional Parameter 

  •  attributemetadata. When set to true, you will get the list of available values for each of the attribute in addition to the selected value for the service.
  • Was this article helpful?