Cisco Secure Access API

the cisco secure access api connector facilitates the integration of cisco's network access control capabilities into third party applications cisco secure access api provides robust security management by allowing users to automate the creation, retrieval, and management of destination lists this integration with swimlane turbine enables seamless automation of security tasks, such as adding or removing destinations from lists, updating list details, and managing tenant information by leveraging this connector, swimlane turbine end users can enhance their security operations with efficient domain management and real time threat response capabilities prerequisites before you can use the cisco secure access api connector for turbine, you'll need access to the cisco secure access api this requires the following custom authentication using the following parameters url the endpoint url for accessing the cisco secure access api api key a unique key provided by cisco for authenticating api requests key secret a secret associated with the api key for enhanced security capabilities this cisco secure access api connector provides the following capabilities get destination list get destination lists get destinations in destination list list tenants create destination list update destination list delete destination list add destinations to destination list delete destinations from destination list get destination list retrieve a destination list from cisco secure access api using the specified destinationlistid as a path parameter cisco's documentation for this action can be found here https //developer cisco com/docs/cloud security/get destination list/ get destination lists get the destination lists in your organization using cisco secure access api cisco's documentation for this action can be found here https //developer cisco com/docs/cloud security/get destination lists/ get destinations in destination list get destinations in a destination list cisco's documentation for this action can be found here https //developer cisco com/docs/cloud security/get destinations in destination list/ list tenants retrieve a list of tenants within the organization using cisco secure access api requires organizationids as input cisco's documentation for this action can be found here https //developer cisco com/docs/cloud security/list tenants/ create destination list create a destination list in your organization using cisco secure access api requires json body with access, name, and isglobal parameters cisco's documentation for this action can be found here https //developer cisco com/docs/cloud security/create destination list/ update destination list update the name of a destination list in your organization using cisco secure access api requires destinationlistid as path parameter and name in json body cisco's documentation for this action can be found here https //developer cisco com/docs/cloud security/update destination list/ delete destination list remove a destination list from your organization in cisco secure access api using the specified destinationlistid cisco's documentation for this action can be found here https //developer cisco com/docs/cloud security/delete destination list/ add destinations to destination list add destinations (domain, url, or ipv4) to a destination list a domain is one type of destination cisco's documentation for this action can be found here https //developer cisco com/docs/cloud security/add destinations to destination list/ delete destinations from destination list remove destinations from a destination list by destination id (max 500 ids per request) use get destinations in destination list to obtain ids cisco's documentation for this action can be found here https //developer cisco com/docs/cloud security/delete destinations from destination list/ configurations asset configuration parameters parameter description type required url base url for the cisco secure access api string required api key secure access api key id string required api secret secure access api key secret string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions add destinations to destination list add domains, urls, or ipv4 addresses to a destination list in cisco secure access api using the destinationlistid path parameter endpoint url /destinationlists/{{destinationlistid}}/destinations method post input argument name type required description path parameters destinationlistid number required the unique id of the destination list input example {"json body" \[{"destination" "cisco com","comment" "a comment about the destination"}],"path parameters" {"destinationlistid" 245}} output parameter type description status code number http status code of the response reason string response reason phrase id number unique identifier organizationid number unique identifier access string output field access isglobal boolean output field isglobal name string name of the resource thirdpartycategoryid number unique identifier createdat number output field createdat modifiedat number output field modifiedat ismspdefault boolean output field ismspdefault markedfordeletion boolean output field markedfordeletion bundletypeid number unique identifier meta object output field meta meta destinationcount number count value output example {"status code" 200,"reason" "ok","json body" {"id" 2477857,"organizationid" 22429759,"access" "none","isglobal"\ false,"name" "new destination list","thirdpartycategoryid" 0,"createdat" 1532628019,"modifiedat" 1532628019,"ismspdefault"\ false,"markedfordeletion"\ false,"bundletypeid" 2,"meta" {"destinationcount" 5}}} create destination list create a destination list in your organization using cisco secure access api requires json body with bundletypeid, access, name, and isglobal parameters endpoint url /destinationlists method post input argument name type required description bundletypeid number optional the type of destination list to create access string optional configure your access rules to block or allow certain destination lists name string optional the name of the destination list isglobal boolean optional specifies whether the destination list is a global destination list destinations array optional the list of destinations destinations destination string optional the destination to block or allow destinations type string optional the type of destination destinations comment string optional the comment about the destination input example {"json body" {"bundletypeid" 2,"access" "none","name" "threat intelligence blocklist","isglobal"\ false,"destinations" \[{"destination" "www internetbadguys com","type" "domain","comment" "known malicious domain"},{"destination" "http //malware example com/payload","type" "url","comment" "malware distribution url"},{"destination" "192 0 2 100","type" "ipv4","comment" "suspicious ip address"}]}} output parameter type description status code number http status code of the response reason string response reason phrase status object status value status code number status value status text string status value data object response data data id number response data data organizationid number response data data access string response data data isglobal boolean response data data name string response data data thirdpartycategoryid number response data data createdat number response data data modifiedat number response data data ismspdefault boolean response data data markedfordeletion boolean response data data bundletypeid number response data data meta object response data data meta destinationcount number response data data meta domaincount number response data data meta urlcount number response data data meta ipv4count number response data data meta ipv6count number response data data meta applicationcount number response data output example {"status code" 200,"reason" "ok","json body" {"status" {"code" 200,"text" "ok"},"data" {"id" 1234567,"organizationid" 2345678,"access" "none","isglobal"\ false,"name" "global allow list","thirdpartycategoryid" 0,"createdat" 1490206249,"modifiedat" 1520476127,"ismspdefault"\ false,"markedfordeletion"\ false,"bundletypeid" 2,"meta" {}}}} delete destination list remove a destination list from your organization in cisco secure access api using the specified destinationlistid endpoint url /destinationlists/{{destinationlistid}} method delete input argument name type required description path parameters destinationlistid number required the unique id of the destination list input example {"path parameters" {"destinationlistid" 245}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"reason" "ok","json body" {}} delete destinations from destination list remove destinations from a destination list in cisco secure access api using destination ids supports up to 500 ids per request use 'get destinations in destination list' to obtain ids endpoint url /destinationlists/{{destinationlistid}}/destinations/remove method delete input argument name type required description path parameters destinationlistid number required the unique id of the destination list input example {"json body" \[12345,987435],"path parameters" {"destinationlistid" 245}} output parameter type description status code number http status code of the response reason string response reason phrase id number unique identifier organizationid number unique identifier access string output field access isglobal boolean output field isglobal name string name of the resource thirdpartycategoryid number unique identifier createdat number output field createdat modifiedat number output field modifiedat ismspdefault boolean output field ismspdefault markedfordeletion boolean output field markedfordeletion bundletypeid number unique identifier meta object output field meta meta destinationcount number count value output example {"status code" 200,"reason" "ok","json body" {"id" 2477857,"organizationid" 22429759,"access" "none","isglobal"\ false,"name" "new destination list","thirdpartycategoryid" 0,"createdat" 1532628019,"modifiedat" 1532628019,"ismspdefault"\ false,"markedfordeletion"\ false,"bundletypeid" 2,"meta" {"destinationcount" 5}}} get destination list retrieve a destination list from cisco secure access api using the specified destinationlistid as a path parameter endpoint url /destinationlists/{{destinationlistid}} method get input argument name type required description path parameters destinationlistid number required the unique id of the destination list input example {"path parameters" {"destinationlistid" 245}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"reason" "ok","json body" {}} get destination lists get the destination lists in your organization using cisco secure access api endpoint url /destinationlists method get input argument name type required description parameters page number optional the page number to get parameters limit number optional the number of items to get per page input example {"parameters" {"page" 1,"limit" 10}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"reason" "ok","json body" \[{"bundletypeid" 1,"createdat" 1576169250,"id" 12345,"modifiedat" 1576259640,"organizationid" 98765,"thirdpartycategoryid" 0,"access" "block","name" "blocked destinations","isglobal"\ false,"ismspdefault"\ false,"markedfordeletion"\ false,"meta" {}},{"bundletypeid" 2,"createdat" 1576186213,"id" 67890,"modifiedat" 1576186213,"organizationid" 98765,"thirdpartycategoryid" 0,"access" "allow","name" "allowed destinations","isglobal"\ false,"ismspdefault"\ false get destinations in destination list get destinations in a specified destination list using the cisco secure access api requires the destinationlistid as a path parameter endpoint url /destinationlists/{{destinationlistid}}/destinations method get input argument name type required description parameters page number optional the number of a page in the collection parameters limit number optional the number of records in the collection to return on the page path parameters destinationlistid number required the unique id of the destination list input example {"parameters" {"page" 4,"limit" 50},"path parameters" {"destinationlistid" 245}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"reason" "ok","json body" \[{"id" "1234590","destination" "cisco com","type" "domain","comment" "a comment about test destination","createdat" "2021 07 23 19 36 45"}]} list tenants retrieve a list of tenants within the organization using cisco secure access api requires organizationids as input endpoint url /tenants/lists method get input argument name type required description parameters organizationids string required a comma separated list of ids for the tenant organizations parameters optionalfields array optional optional fields to request additional data along with regular response parameters filters object optional filters that can be applied to the response by the system parameters filters organizationid number optional filter by the id of the tenant parameters filters organizationname string optional filter by the name of the tenant parameters sort object optional the properties to sort the collection parameters sort order\[organizationid] string optional the order to use when sorting the id of the tenants parameters sort order\[organizationname] string optional the order to use when sorting the name of the tenants input example {"parameters" {"organizationids" "1234567,2345678,3123456,4234567","optionalfields" \["name","email","phone","address","city","state"],"filters" {"organizationid" 1234567,"organizationname" "acme corporation"},"sort" {"order\[organizationid]" "asc","order\[organizationname]" "desc"}}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"reason" "ok","json body" \[{"organizationid" 1234567,"organizationname" "tenant one"}]} update destination list update the name of a destination list in your organization using cisco secure access api requires destinationlistid as a path parameter and name in json body endpoint url /destinationlists/{{destinationlistid}} method patch input argument name type required description path parameters destinationlistid number required the unique id of the destination list name string optional the name of the destination list input example {"json body" {"name" "global allow list"},"path parameters" {"destinationlistid" 245}} output parameter type description status code number http status code of the response reason string response reason phrase id number unique identifier organizationid number unique identifier access string output field access isglobal boolean output field isglobal name string name of the resource thirdpartycategoryid number unique identifier createdat number output field createdat modifiedat number output field modifiedat ismspdefault boolean output field ismspdefault markedfordeletion boolean output field markedfordeletion bundletypeid number unique identifier meta object output field meta meta destinationcount number count value output example {"status code" 200,"reason" "ok","json body" {"id" 2477857,"organizationid" 22429759,"access" "none","isglobal"\ false,"name" "new name of destination list","thirdpartycategoryid" 0,"createdat" 1532628019,"modifiedat" 1532628019,"ismspdefault"\ false,"markedfordeletion"\ false,"bundletypeid" 2,"meta" {"destinationcount" 1}}} response headers header description example content type the media type of the resource application/json date the date and time at which the message was originated thu, 01 jan 2024 00 00 00 gmt