Skip to content

Image Relationships

IMAGES


List all image relationships

GET /api/container_images/{container-image-id}/image_relationships

OAuth Authorization Required: images_read, public

Schema
  • image_relationships: Array
    • container_image_id: Integer
    • requires_container_id: Integer
    • default_variant_id: Integer | Override the default variant for the specified image.
    • created_at: DateTime
    • updated_at: DateTime

Show a container image relationship

GET /api/container_images/{container-image-id}/image_relationships/{id}

OAuth Authorization Required: images_read, public

Schema
  • image_relationship: Object
    • container_image_id: Integer
    • requires_container_id: Integer
    • default_variant_id: Integer | Override the default variant for the specified image.
    • created_at: DateTime

Update a container image relationship

PATCH /api/container_images/{container-image-id}/image_relationships/{id}

OAuth Authorization Required: images_write

Schema
  • image_relationship: Object
    • requires_container_id: Integer
    • default_variant_id: Integer | Override the default variant for the specified image.

Create a container image relationship

POST /api/container_images/{container-image-id}/image_relationships

OAuth Authorization Required: images_write

Schema
  • image_relationship: Object
    • requires_container_id: Integer
    • default_variant_id: Integer | Override the default variant for the specified image.

Delete a container image relationship

DELETE /api/container_images/{container-image-id}/image_relationships/{id}

OAuth Authorization Required: images_write