AIaikido

List containers

Returns a list of all the active container repositories in your account

get/containers

Request

  • Base URL
    https://app.aikido.dev/api/public/v1
  • URL
    https://app.aikido.dev/api/public/v1/containers
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://app.aikido.io/api/oauth/token scopes: repositories:read

Query parameters

pageinteger

Pagination parameter, starts at 0.

per_pageinteger

Amount of items returned

filter_namestring

Filters containers on container name

filter_tagstring

Filters containers on tag

filter_team_idinteger

Filters containers for a specific team

filter_status'all' | 'active' | 'inactive'

Filters containers on status. Default value is 'active'

filter_reachability'unknown' | 'direct' | 'lb' | 'limited_ips' | 'none'

Filters containers on how their running images are reachable from the internet.

include_is_runningboolean

Include whether each container is currently running anywhere.

include_sensitivityboolean

Include the sensitivity of the container.

include_connectivityboolean

Include the connectivity of the container.

include_labelsboolean

Include labels in the response

Response

A list of container repositories

idinteger required

The repository's id in Aikido.

namestring required

The name of the code repository.

provider'aws' | 'gcp-artifact-registry' | 'gcp-container-registry' | 'aws' | 'docker-hub' | 'github' | 'quay' | 'acr' | 'gitlab' | 'gitlab-self' | 'digitalocean' | 'scaleway' | 'cloudsmith' | 'harbor' | 'artifactory' | 'custom_upload' | 'oci' | 'kubernetes' required

The provider place where the code repository is hosted

cloud_idinteger nullable required

The ID of the cloud that acts as the registry where this container is located in.

registry_idinteger nullable required

The ID of the registry where this container is located in.

registry_namestring nullable required

The name of the container registry.

tagstring required

The tag filter used when selecting an image. If empty the latest image will be scanned.

distrostring

The distribution of the image's OS.

distro_versionstring

The distribution version of the image's OS.

last_scanned_atinteger

Timestamp representing the last time a scan for this container ended. Value is -1 when no scan happened yet.

last_scanned_tagstring

The container image tag that was used in the latest scan.

last_scanned_digeststring nullable

The sha256 digest of the container image that was used in the latest scan. Value is 'null' when no scan happened yet.

linked_code_repo_idstring

The id of the code repo to which this container is linked. Value is 'null' when no code repo is linked.

last_pushed_atinteger

Timestamp representing the last a digest was pushed to this container. Value is -1 when this is unknown.

created_atinteger

Timestamp representing when the container was created in Aikido.

is_activeboolean

Whether the container is being scanned by Aikido.

is_emptyboolean

Whether the container repository has no image pushed to it.

is_runningboolean

Whether the container is currently running anywhere.

exposed_via'unknown' | 'direct' | 'lb' | 'limited_ips' | 'none'

How the running container image is reachable from the internet. Values direct, lb, and limited_ips indicate the image is reachable; none indicates it is not reachable; unknown indicates reachability could not be determined.

connectivity'connected' | 'not_connected' | 'unknown'

Tells Aikido if this code runs in an internet-connected server

sensitivity'extreme' | 'sensitive' | 'normal' | 'not_sensitive' | 'no_data'

The sensitivity of the repository.

Example response

{
  "id": 1,
  "name": "pied-piper/compression",
  "provider": "aws_ecr",
  "cloud_id": null,
  "registry_id": 3,
  "registry_name": "Pied Piper Global Cloud Infrastructure",
  "tag": "prod-*",
  "distro": "debian",
  "distro_version": "12",
  "last_scanned_at": 1720083163,
  "last_scanned_tag": "prod-20250623",
  "last_scanned_digest": "sha256:9b1c8c0e2e5f4a7d3b6e8f1a2c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d",
  "linked_code_repo_id": 67,
  "last_pushed_at": 1720083163,
  "created_at": 1720070000,
  "is_active": true,
  "is_empty": false,
  "is_running": true,
  "exposed_via": "lb",
  "connectivity": "connected",
  "sensitivity": "sensitive",
  "labels": [
    {
      "id": 1,
      "name": "production",
      "is_imported": false
    },
    {
      "id": 2,
      "name": "core",
      "is_imported": true
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.