Get Defender Names
GET/api/v32.07/defenders/names
x-prisma-cloud-target-env: {"permission":"manageDefenders"}
Retrieves a list of Defender hostnames that can be used as the {id}
query parameter in other /api/v1/defenders
endpoints.
cURL Request
Refer to the following example cURL command that retrieves a list of all Defenders:
$ curl -k \
-u <USER> \
-H 'Content-Type: application/json' \
-X GET \
https://<CONSOLE>/api/v<VERSION>/defenders/names
Refer to the following example cURL command that retrieves a list of connected Defenders using a query parameter and a specified boolean value in lower case:
$ curl -k \
-u <USER> \
-H 'Content-Type: application/json' \
-X GET \
"https://<CONSOLE>/api/v<VERSION>/defenders/names?connected=true"
Refer to the following example cURL command that retrieves a list of disconnected Defenders using a query parameter and a specified boolean value in lower case:
$ curl -k \
-u <USER> \
-H 'Content-Type: application/json' \
-X GET \
"https://<CONSOLE>/api/v<VERSION>/defenders/names?connected=false"
Note: The query parameter connected
expects and accepts a boolean value in lower case.
The endpoint enlists all the connected and disconnected Defenders if do not specify a boolean value.
Refer to the following example cURL command that retrieves a list of Defenders by type:
$ curl -k \
-u <USER> \
-H 'Content-Type: application/json' \
-X GET \
"https://<CONSOLE>/api/v<VERSION>/defenders/names?type=<linux|windows|docker|...>"
Request
Query Parameters
Offsets the result to a specific report count. Offset starts from 0.
Limit is the amount to fix.
Sorts the result using a key.
Sorts the result in reverse order.
Hostname is a name of a specific Defender to retrieve.
Roles are the defender api.Roles to filter.
Indicates whether to return only connected Defenders (true) or disconnected Defenders (false).
Indicates the Defender types to return (e.g., docker, dockerWindows, cri, etc).
Indicates whether to return a list of Defenders that are running the latest version of Prisma Cloud (true) or defenders with older versions (false).
SupportedVersion indicates only Defenders of supported versions should be fetched.
Scopes the query by cluster name.
Scopes the query by TAS cluster IDs.
Scopes the query by TAS blobstore scanning only Defenders (true) or TAS full coverage Defenders (false).
Scopes the query by TAS foundations.
Scopes the query to defenders which are using old certificate.
Scopes the query to defenders which are using expired certificate.
Scopes the query by provider type Indicates whether to return only defenders running on ARM64 architecture.
Indicates whether to return only defenders running as VPC Observer.
Responses
- 200
- default
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
string
[
"string"
]