List Service Objects - Cloud Security API

{"type":"api","title":"List Service Objects","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/9d37d008417d562ab46d4b67547a68457ce288d2/b36b2683-243e-3edc-8c84-85b5f4140afd","info":{"version":"1.0.1","title":"Cisco Secure Access Network and Service Objects API","description":"Manage the Network and Service Objects in the organization.","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Network Objects","description":"Manage the Network Objects in the organization."},{"name":"Network Object Groups","description":"Manage the Network Object Groups in the organization."},{"name":"Service Objects","description":"Manage the Service Objects in the organization."},{"name":"Service Object Groups","description":"Manage the Service Object Groups in the organization."},{"name":"Unified Objects","description":"List the Objects and Object Groups in the organization."},{"name":"Secure Access"}],"x-parser-conf":{"overview":{"markdownPath":"secure-access/reference/policies/network-and-service-objects-overview.md","uri":"secure-access-api-reference-network-and-service-objects-overview"}},"openapi":"3.0.1","servers":[{"url":"https://api.sse.cisco.com/{basePath}","variables":{"basePath":{"default":"policies/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"Client credential flow.","flows":{"clientCredentials":{"tokenUrl":"https://api.sse.cisco.com/auth/v2/token","scopes":{"policies.objects.networkObjects:read":"Read the Network Object resources","policies.objects.networkObjectGroups:read":"Read the Network Object Group resources","policies.objects.networkObjects:write":"Write the Network Object resources","policies.objects.networkObjectGroups:write":"Write the Network Object Group resources","policies.objects.serviceObjects:read":"Read the Service Object resources","policies.objects.serviceObjectGroups:read":"Read the Service Object Groups resources","policies.objects.serviceObjects:write":"Write the Service Object resources","policies.objects.serviceObjectGroups:write":"Write the Service Object Group resources"}}}}}},"spec":{"tags":["Service Objects","Secure Access"],"summary":"List Service Objects","description":"Get the Service Objects in the organization.","parameters":[{"name":"offset","in":"query","required":false,"description":"The place to start reading in the collection. The offset starts at 0.\nIf the `limit` is 10, the offset for the next response is 10. The default value is 0.","schema":{"type":"integer","default":0},"example":25,"$$ref":"#/components/parameters/offset"},{"name":"limit","in":"query","required":false,"description":"The maximum number of items from the collection to return in the response. The default value is 10.","schema":{"type":"integer","default":10},"example":1000,"$$ref":"#/components/parameters/limit"},{"name":"name","in":"query","required":false,"description":"The name of an object.","schema":{"type":"string","default":""},"$$ref":"#/components/parameters/name"},{"name":"description","in":"query","required":false,"description":"A meaningful description for an object.","schema":{"type":"string","default":""},"$$ref":"#/components/parameters/description"},{"name":"value","in":"query","required":false,"description":"The list of ports to query the value of the Service Object.","schema":{"type":"string"},"example":"8080","$$ref":"#/components/parameters/soValue"},{"name":"type","in":"query","required":false,"description":"The type of the Service Object.","schema":{"type":"string","enum":["tcp","udp","icmp","any"],"example":"tcp"},"$$ref":"#/components/parameters/soType"}],"security":[{"oauthFlow":["policies.objects.serviceObjects:read"]}],"operationId":"getServiceObjects","responses":{"200":{"description":"OK","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"The metadata about the Service Objects in the collection and the list of Service Objects.","properties":{"count":{"type":"integer","description":"The number of items that are returned in the response.","example":2,"$$ref":"#/components/schemas/count"},"limit":{"type":"integer","description":"The maximum number of items from the collection that are returned in the response.","example":100,"$$ref":"#/components/schemas/limit"},"offset":{"type":"integer","description":"The place (index) to start reading in the collection.","example":0,"$$ref":"#/components/schemas/offset"},"results":{"type":"array","description":"The list of objects in the response.","items":{"type":"object","description":"The properties of the Service Object response.","required":["id","name","value","url"],"properties":{"id":{"type":"integer","description":"The ID of the Service Object.","example":123456,"$$ref":"#/components/schemas/idServiceObject"},"name":{"type":"string","description":"The name of the Service Object.","example":"mycompany service object group name","$$ref":"#/components/schemas/nameServiceObject"},"description":{"type":"string","description":"The description of the Service Object.","example":"mycompany service object group description","$$ref":"#/components/schemas/descriptionServiceObject"},"value":{"type":"object","description":"The properties of the Service.","required":["protocol","ports"],"properties":{"protocol":{"type":"string","description":"The protocol of the Service.","enum":["tcp","udp","icmp","any"],"example":"tcp"},"ports":{"type":"array","description":"The list of ports or port ranges for the Service.","items":{"type":"string","description":"A string that specifies a port number.","example":"4567"},"example":["9090","8000"]}},"example":{"protocol":"tcp","ports":["6589"]},"$$ref":"#/components/schemas/ServiceValueType"},"url":{"type":"string","description":"The URL for the Service Object.","example":"http://api.sse.cisco.com/v1/objects/services/1245"},"created_at":{"type":"string","format":"date-time","description":"The date and time when the object was created, specified in the ISO 8601 format.","example":"2021-10-02T20:00:00Z","$$ref":"#/components/schemas/created_at"},"modified_at":{"type":"string","format":"date-time","description":"The date and time when the object was updated, specified in the ISO 8601 format.","example":"2021-11-02T20:00:00Z","$$ref":"#/components/schemas/modified_at"},"modified_by":{"type":"string","description":"The hash of the ID for the user account that modified the object.","example":"12089817","$$ref":"#/components/schemas/modified_by"}},"example":{"id":15906,"name":"new service object one","description":"description for service object one","value":{"protocol":"tcp","ports":["6589"]},"url":"https://api.sse.cisco.com/policies/v2/objects/serviceObjects/15906","created_at":"2024-11-20T14:09:19.686Z","modified_at":"2024-11-20T14:09:19.686Z","modified_by":"85e0c78b608a4336adb50d7bafdf6032"},"$$ref":"#/components/schemas/ServiceObjectResponseSchema"},"example":[{"id":15906,"name":"new service object one","description":"description for service object one","value":{"protocol":"tcp","ports":["6589"]},"url":"https://api.sse.cisco.com/policies/v2/objects/serviceObjects/15906","created_at":"2024-11-20T14:09:19.686Z","modified_at":"2024-11-20T14:09:19.686Z","modified_by":"85e0c78b608a4336adb50d7bafdf6032"}]}}},"example":{"count":1,"limit":10,"offset":0,"results":[{"id":37,"name":"Service object name","description":"Service Object description","value":{"protocol":"tcp","ports":["4567"]},"url":"https://api.sse.cisco.com/policies/v2/objects/serviceObjects/37","created_at":"2024-10-06T19:54:19Z","modified_at":"2024-10-06T19:54:19Z","modified_by":"12089817"}]}}}},"400":{"description":"Bad Request","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"The properties of the error message.","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Organization ID must be a numeric value."}},"$$ref":"#/components/schemas/400ErrorObject"}}},"$$ref":"#/components/responses/400Error"},"401":{"description":"Unauthorized","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"The properties of the error message.","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Authorization token is invalid."}},"$$ref":"#/components/schemas/401ErrorObject"}}},"$$ref":"#/components/responses/401Error"},"403":{"description":"Forbidden","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"The properties of the error message.","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Not Authorized"}},"$$ref":"#/components/schemas/403ErrorObject"}}},"$$ref":"#/components/responses/403Error"},"404":{"description":"Not Found","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"The properties of the error message.","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Not Found"}},"$$ref":"#/components/schemas/404ErrorObject"}}},"$$ref":"#/components/responses/404Error"},"500":{"description":"Internal Server Error","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"The properties of the error message.","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Internal Server Error"}},"$$ref":"#/components/schemas/500ErrorObject"}}},"$$ref":"#/components/responses/500Error"}},"__originalOperationId":"getServiceObjects","method":"get","path":"/objects/serviceObjects"}}