AIaikido

Get container

Returns the requested container repository

get/containers/{container_repo_id}

Request

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

Path parameters

container_repo_idinteger required

Container repo ID

Query parameters

include_teamsboolean

Whether to include the teams responsible for the container repository

Response

The container repository details

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.

is_activeboolean

Whether the container is active.

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,
  "is_active": true,
  "labels": [
    {
      "id": 1,
      "name": "production",
      "is_imported": false
    },
    {
      "id": 2,
      "name": "core",
      "is_imported": true
    }
  ],
  "linked_teams": [
    {
      "id": 1,
      "name": "production"
    },
    {
      "id": 2,
      "name": "core"
    }
  ]
}

Changes

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