Skip to main content

Get Container Names​

x-prisma-cloud-target-env: {"permission":"monitorImages","saas":true,"self-hosted":true}
x-public: true

Returns an array of strings containing all container names.

cURL Request​

Refer to the following example cURL command:

$ curl -k \
  -u <USER> \
  -H 'Content-Type: application/json' \
  -X GET \
  https://<CONSOLE>/api/v<VERSION>/containers/names
Query Parameters
  • offset integer

    Offsets the result to a specific report count. Offset starts from 0.

  • limit integer

    Number of reports to retrieve in a page. For PCCE, the maximum limit is 250. For PCEE, the maximum limit is 50. The default value is 50.

  • search string

    Retrieves the result for a search term.

  • sort string

    Sorts the result using a key. Refer to the columns in the relevant Prisma Cloud Compute user interface to use them as sort keys.

  • reverse boolean

    Sorts the result in reverse order.

  • collections string[]

    Filters the result based on collection names that you have defined in Prisma Cloud Compute.

  • provider string[]

    Scopes the query by cloud provider.

  • accountIDs string[]

    Filters the result based on cloud account IDs.

  • resourceIDs string[]

    Scopes the query by resource ID.

  • region string[]

    Scopes the query by cloud region.

  • fields string[]

    Retrieves the fields that you need in a report. Use the list of fields you want to retrieve. By default, the result shows all fields of data.

  • hostname string[]

    Hosts is used to filter containers by host.

  • image string[]

    Images is used to filter containers by image name.

  • imageId string[]

    ImageIDs is used to filter containers by image ids.

  • id string[]

    IDs is used to filter container by container ID.

  • profileId string[]

    ProfileIDs is used to filter container by runtime profile ID.

  • namespaces string[]

    Namespaces are the namespaces to filter.

  • firewallSupported boolean

    FirewallSupported is used to fetch containers with app firewall supported.

  • clusters string[]

    Clusters is used to filter containers by cluster name.

  • complianceIDs int[]

    ComplianceIDs is used to filter containers by compliance IDs.

  • agentless boolean

    Agentless indicates that we should return only containers that were scanned by an agentless scanner.

Responses
Schema
  • Array [
  • string
  • ]
Loading...