Getiteration — GetIteration allows the user to retrieve an iteration using one of the following identifiers: * iteration_id * incremental_version * fingerprint
Getchildimages — GET /packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/iterations/{incremental_version}/children
Createbuild — POST /packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/iterations/{iteration_id}
Listbuilds — GET /packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/iterations/{iteration_id}/builds
Updateiteration — UpdateIteration is used to mark an iteration "complete", once all builds are complete. To make build-specific updates for builds within the iteration, use the UpdateBuild endpoint.
GetIteration allows the user to retrieve an iteration using one of the following identifiers: * iteration_id * incremental_version * fingerprint
read-onlyidempotent
listiterations
GET /packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/iterations
read-onlyidempotent
createiteration
POST /packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/iterations
getancestorimages
API Endpoints to ease UI implementation
read-onlyidempotent
getchildimages
GET /packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/iterations/{incremental_version}/children
read-onlyidempotent
createbuild
POST /packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/iterations/{iteration_id}
listbuilds
GET /packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/iterations/{iteration_id}/builds
UpdateIteration is used to mark an iteration "complete", once all builds are complete. To make build-specific updates for builds within the iteration, use the UpdateBuild endpoint.
getregistry
GET /packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/registry
read-onlyidempotent
createregistry
PUT /packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/registry
naftiko: 1.0.0-alpha2
info:
label: HashiCorp Cloud Platform Packer Artifact Registry
description: API for managing Packer images.
tags:
- Packer
- API
created: '2026-05-06'
modified: '2026-05-06'
capability:
consumes:
- type: http
namespace: packer
baseUri: //api.cloud.hashicorp.com
description: HashiCorp Cloud Platform Packer Artifact Registry HTTP API.
authentication:
type: apikey
in: header
name: Authorization
value: '{{PACKER_TOKEN}}'
resources:
- name: packer-2021-04-30-organizations-location-organiz
path: /packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/builds/{build_id}
operations:
- name: getbuild
method: GET
description: GET /packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/builds/{build_id}
inputParameters:
- name: location.organization_id
in: path
type: string
required: true
description: organization_id is the id of the organization.
- name: location.project_id
in: path
type: string
required: true
description: project_id is the projects id.
- name: build_id
in: path
type: string
required: true
description: Unique identifier of the build that should be retrieved; this ID was created and set by the HCP Packer
registry when the build was created.
- name: location.region.provider
in: query
type: string
description: provider is the named cloud provider ("aws", "gcp", "azure").
- name: location.region.region
in: query
type: string
description: region is the cloud region ("us-west1", "us-east1").
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: deletebuild
method: DELETE
description: DELETE /packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/builds/{build_id}
inputParameters:
- name: location.organization_id
in: path
type: string
required: true
description: organization_id is the id of the organization.
- name: location.project_id
in: path
type: string
required: true
description: project_id is the projects id.
- name: build_id
in: path
type: string
required: true
description: Unique identifier of the build that should be deleted; this ID was created and set by the HCP Packer
registry when the build was created.
- name: location.region.provider
in: query
type: string
description: provider is the named cloud provider ("aws", "gcp", "azure").
- name: location.region.region
in: query
type: string
description: region is the cloud region ("us-west1", "us-east1").
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: updatebuild
method: PATCH
description: PATCH /packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/builds/{build_id}
inputParameters:
- name: location.organization_id
in: path
type: string
required: true
description: organization_id is the id of the organization.
- name: location.project_id
in: path
type: string
required: true
description: project_id is the projects id.
- name: build_id
in: path
type: string
required: true
description: Unique identifier of the build that should be updated; this ID was created and set by the HCP Packer
registry when the build was created.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: packer-2021-04-30-organizations-location-organiz
path: /packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images
operations:
- name: listbuckets
method: GET
description: GET /packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images
inputParameters:
- name: location.organization_id
in: path
type: string
required: true
description: organization_id is the id of the organization.
- name: location.project_id
in: path
type: string
required: true
description: project_id is the projects id.
- name: location.region.provider
in: query
type: string
description: provider is the named cloud provider ("aws", "gcp", "azure").
- name: location.region.region
in: query
type: string
description: region is the cloud region ("us-west1", "us-east1").
- name: pagination.page_size
in: query
type: integer
description: The max number of results per page that should be returned. If the number of available results is larger
than `page_size`, a `next_page_token` is returned which
- name: pagination.next_page_token
in: query
type: string
description: Specifies a page token to use to retrieve the next page. Set this to the `next_page_token` returned
by previous list requests to get the next page of results. I
- name: pagination.previous_page_token
in: query
type: string
description: Specifies a page token to use to retrieve the previous page. Set this to the `previous_page_token`
returned by previous list requests to get the previous page o
- name: sorting.order_by
in: query
type: array
description: Specifies the list of per field ordering that should be used for sorting. The order matters as rows
are sorted in order by fields and when the field matches, th
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: createbucket
method: PUT
description: PUT /packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images
inputParameters:
- name: location.organization_id
in: path
type: string
required: true
description: organization_id is the id of the organization.
- name: location.project_id
in: path
type: string
required: true
description: project_id is the projects id.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: packer-2021-04-30-organizations-location-organiz
path: /packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}
operations:
- name: getbucket
method: GET
description: GET /packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}
inputParameters:
- name: location.organization_id
in: path
type: string
required: true
description: organization_id is the id of the organization.
- name: location.project_id
in: path
type: string
required: true
description: project_id is the projects id.
- name: bucket_slug
in: path
type: string
required: true
description: Human-readable name for the bucket.
- name: location.region.provider
in: query
type: string
description: provider is the named cloud provider ("aws", "gcp", "azure").
- name: location.region.region
in: query
type: string
description: region is the cloud region ("us-west1", "us-east1").
- name: bucket_id
in: query
type: string
description: Unique identifier of the bucket; created and set by the HCP Packer registry when the bucket is created.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: deletebucket
method: DELETE
description: DELETE /packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}
inputParameters:
- name: location.organization_id
in: path
type: string
required: true
description: organization_id is the id of the organization.
- name: location.project_id
in: path
type: string
required: true
description: project_id is the projects id.
- name: bucket_slug
in: path
type: string
required: true
description: Human-readable name for the bucket.
- name: location.region.provider
in: query
type: string
description: provider is the named cloud provider ("aws", "gcp", "azure").
- name: location.region.region
in: query
type: string
description: region is the cloud region ("us-west1", "us-east1").
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: updatebucket
method: PATCH
description: PATCH /packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}
inputParameters:
- name: location.organization_id
in: path
type: string
required: true
description: organization_id is the id of the organization.
- name: location.project_id
in: path
type: string
required: true
description: project_id is the projects id.
- name: bucket_slug
in: path
type: string
required: true
description: Human-readable name for the bucket.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: packer-2021-04-30-organizations-location-organiz
path: /packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/channels
operations:
- name: listchannels
method: GET
description: GET /packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/channels
inputParameters:
- name: location.organization_id
in: path
type: string
required: true
description: organization_id is the id of the organization.
- name: location.project_id
in: path
type: string
required: true
description: project_id is the projects id.
- name: bucket_slug
in: path
type: string
required: true
description: Human-readable name for the bucket you want to list channels for.
- name: location.region.provider
in: query
type: string
description: provider is the named cloud provider ("aws", "gcp", "azure").
- name: location.region.region
in: query
type: string
description: region is the cloud region ("us-west1", "us-east1").
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: createchannel
method: POST
description: POST /packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/channels
inputParameters:
- name: location.organization_id
in: path
type: string
required: true
description: organization_id is the id of the organization.
- name: location.project_id
in: path
type: string
required: true
description: project_id is the projects id.
- name: bucket_slug
in: path
type: string
required: true
description: Human-readable name for the bucket to associate the channel with.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: packer-2021-04-30-organizations-location-organiz
path: /packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/channels/{slug}
operations:
- name: getchannel
method: GET
description: GET /packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/channels/{slug}
inputParameters:
- name: location.organization_id
in: path
type: string
required: true
description: organization_id is the id of the organization.
- name: location.project_id
in: path
type: string
required: true
description: project_id is the projects id.
- name: bucket_slug
in: path
type: string
required: true
description: Human-readable name for the bucket that the channel is associated with.
- name: slug
in: path
type: string
required: true
description: Human-readable name for the channel.
- name: location.region.provider
in: query
type: string
description: provider is the named cloud provider ("aws", "gcp", "azure").
- name: location.region.region
in: query
type: string
description: region is the cloud region ("us-west1", "us-east1").
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: deletechannel
method: DELETE
description: DELETE /packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/channels/{slug}
inputParameters:
- name: location.organization_id
in: path
type: string
required: true
description: organization_id is the id of the organization.
- name: location.project_id
in: path
type: string
required: true
description: project_id is the projects id.
- name: bucket_slug
in: path
type: string
required: true
description: Human-readable name for the bucket that the channel is associated with.
- name: slug
in: path
type: string
required: true
description: Human-readable name for the channel.
- name: location.region.provider
in: query
type: string
description: provider is the named cloud provider ("aws", "gcp", "azure").
- name: location.region.region
in: query
type: string
description: region is the cloud region ("us-west1", "us-east1").
- name: revocation_message
in: query
type: string
description: Optional field to provide the reason for why this channel is being revoked. Only useful for a channel
that is assigned to an iteration.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: updatechannel
method: PATCH
description: PATCH /packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/channels/{slug}
inputParameters:
- name: location.organization_id
in: path
type: string
required: true
description: organization_id is the id of the organization.
- name: location.project_id
in: path
type: string
required: true
description: project_id is the projects id.
- name: bucket_slug
in: path
type: string
required: true
description: Human-readable name for the bucket that the channel is associated with.
- name: slug
in: path
type: string
required: true
description: Human-readable name for the channel.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: packer-2021-04-30-organizations-location-organiz
path: /packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/iteration
operations:
- name: getiteration
method: GET
description: 'GetIteration allows the user to retrieve an iteration using one of the following identifiers: * iteration_id
* incremental_version * fingerprint'
inputParameters:
- name: location.organization_id
in: path
type: string
required: true
description: organization_id is the id of the organization.
- name: location.project_id
in: path
type: string
required: true
description: project_id is the projects id.
- name: bucket_slug
in: path
type: string
required: true
description: Human-readable name for the bucket.
- name: location.region.provider
in: query
type: string
description: provider is the named cloud provider ("aws", "gcp", "azure").
- name: location.region.region
in: query
type: string
description: region is the cloud region ("us-west1", "us-east1").
- name: incremental_version
in: query
type: integer
description: The human-readable version number assigned to this iteration.
- name: iteration_id
in: query
type: string
description: Unique identifier of the iteration. This was created and set by the HCP Packer registry when the iteration
was created.
- name: fingerprint
in: query
type: string
description: Fingerprint of the iteration. The fingerprint is set by Packer when you call `packer build`. It will
most often correspond to a git commit sha, but can be manua
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: packer-2021-04-30-organizations-location-organiz
path: /packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/iterations
operations:
- name: listiterations
method: GET
description: GET /packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/iterations
inputParameters:
- name: location.organization_id
in: path
type: string
required: true
description: organization_id is the id of the organization.
- name: location.project_id
in: path
type: string
required: true
description: project_id is the projects id.
- name: bucket_slug
in: path
type: string
required: true
description: Human-readable name for the bucket.
- name: location.region.provider
in: query
type: string
description: provider is the named cloud provider ("aws", "gcp", "azure").
- name: location.region.region
in: query
type: string
description: region is the cloud region ("us-west1", "us-east1").
- name: include_incomplete
in: query
type: boolean
description: If true, the request will return information about iterations that have not been marked "complete".
By default, this is false and the list request will only ret
- name: pagination.page_size
in: query
type: integer
description: The max number of results per page that should be returned. If the number of available results is larger
than `page_size`, a `next_page_token` is returned which
- name: pagination.next_page_token
in: query
type: string
description: Specifies a page token to use to retrieve the next page. Set this to the `next_page_token` returned
by previous list requests to get the next page of results. I
- name: pagination.previous_page_token
in: query
type: string
description: Specifies a page token to use to retrieve the previous page. Set this to the `previous_page_token`
returned by previous list requests to get the previous page o
- name: sorting.order_by
in: query
type: array
description: Specifies the list of per field ordering that should be used for sorting. The order matters as rows
are sorted in order by fields and when the field matches, th
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: createiteration
method: POST
description: POST /packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/iterations
inputParameters:
- name: location.organization_id
in: path
type: string
required: true
description: organization_id is the id of the organization.
- name: location.project_id
in: path
type: string
required: true
description: project_id is the projects id.
- name: bucket_slug
in: path
type: string
required: true
description: Human-readable name for the bucket.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: packer-2021-04-30-organizations-location-organiz
path: /packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/iterations/{incremental_version}/ancestors
operations:
- name: getancestorimages
method: GET
description: API Endpoints to ease UI implementation
inputParameters:
- name: location.organization_id
in: path
type: string
required: true
description: organization_id is the id of the organization.
- name: location.project_id
in: path
type: string
required: true
description: project_id is the projects id.
- name: bucket_slug
in: path
type: string
required: true
description: Human-readable name for the bucket.
- name: incremental_version
in: path
type: integer
required: true
description: The human-readable version number assigned to this iteration.
- name: location.region.provider
in: query
type: string
description: provider is the named cloud provider ("aws", "gcp", "azure").
- name: location.region.region
in: query
type: string
description: region is the cloud region ("us-west1", "us-east1").
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: packer-2021-04-30-organizations-location-organiz
path: /packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/iterations/{incremental_version}/children
operations:
- name: getchildimages
method: GET
description: GET /packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/iterations/{incremental_version}/children
inputParameters:
- name: location.organization_id
in: path
type: string
required: true
description: organization_id is the id of the organization.
- name: location.project_id
in: path
type: string
required: true
description: project_id is the projects id.
- name: bucket_slug
in: path
type: string
required: true
description: Human-readable name for the bucket.
- name: incremental_version
in: path
type: integer
required: true
description: The human-readable version number assigned to this iteration.
- name: location.region.provider
in: query
type: string
description: provider is the named cloud provider ("aws", "gcp", "azure").
- name: location.region.region
in: query
type: string
description: region is the cloud region ("us-west1", "us-east1").
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: packer-2021-04-30-organizations-location-organiz
path: /packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/iterations/{iteration_id}
operations:
- name: createbuild
method: POST
description: POST /packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/iterations/{iteration_id}
inputParameters:
- name: location.organization_id
in: path
type: string
required: true
description: organization_id is the id of the organization.
- name: location.project_id
in: path
type: string
required: true
description: project_id is the projects id.
- name: bucket_slug
in: path
type: string
required: true
description: Human-readable name for the bucket.
- name: iteration_id
in: path
type: string
required: true
description: Unique identifier of the iteration that this build should be associated with.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: packer-2021-04-30-organizations-location-organiz
path: /packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/iterations/{iteration_id}/builds
operations:
- name: listbuilds
method: GET
description: GET /packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/iterations/{iteration_id}/builds
inputParameters:
- name: location.organization_id
in: path
type: string
required: true
description: organization_id is the id of the organization.
- name: location.project_id
in: path
type: string
required: true
description: project_id is the projects id.
- name: bucket_slug
in: path
type: string
required: true
description: Human-readable name for the bucket to list builds for.
- name: iteration_id
in: path
type: string
required: true
description: Unique identifier of the iteration to list builds for; this was created and set by the HCP Packer registry
when the iteration was created.
- name: location.region.provider
in: query
type: string
description: provider is the named cloud provider ("aws", "gcp", "azure").
- name: location.region.region
in: query
type: string
description: region is the cloud region ("us-west1", "us-east1").
- name: pagination.page_size
in: query
type: integer
description: The max number of results per page that should be returned. If the number of available results is larger
than `page_size`, a `next_page_token` is returned which
- name: pagination.next_page_token
in: query
type: string
description: Specifies a page token to use to retrieve the next page. Set this to the `next_page_token` returned
by previous list requests to get the next page of results. I
- name: pagination.previous_page_token
in: query
type: string
description: Specifies a page token to use to retrieve the previous page. Set this to the `previous_page_token`
returned by previous list requests to get the previous page o
- name: sorting.order_by
in: query
type: array
description: Specifies the list of per field ordering that should be used for sorting. The order matters as rows
are sorted in order by fields and when the field matches, th
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: packer-2021-04-30-organizations-location-organiz
path: /packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/iterations/{iteration_id}
operations:
- name: deleteiteration
method: DELETE
description: DELETE /packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/iterations/{iteration_id}
inputParameters:
- name: location.organization_id
in: path
type: string
required: true
description: organization_id is the id of the organization.
- name: location.project_id
in: path
type: string
required: true
description: project_id is the projects id.
- name: iteration_id
in: path
type: string
required: true
description: Unique identifier of the iteration. This was created and set by the HCP Packer registry when the iteration
was created.
- name: location.region.provider
in: query
type: string
description: provider is the named cloud provider ("aws", "gcp", "azure").
- name: location.region.region
in: query
type: string
description: region is the cloud region ("us-west1", "us-east1").
- name: bucket_slug
in: query
type: string
description: Human-readable name for the bucket.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: updateiteration
method: PATCH
description: UpdateIteration is used to mark an iteration "complete", once all builds are complete. To make build-specific
updates for builds within the iteration, use the UpdateBuild endpoint.
inputParameters:
- name: location.organization_id
in: path
type: string
required: true
description: organization_id is the id of the organization.
- name: location.project_id
in: path
type: string
required: true
description: project_id is the projects id.
- name: iteration_id
in: path
type: string
required: true
description: Unique identifier of the iteration. This was created and set by the HCP Packer registry when the iteration
was created.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: packer-2021-04-30-organizations-location-organiz
path: /packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/registry
operations:
- name: getregistry
# --- truncated at 32 KB (84 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/packer/refs/heads/main/capabilities/packer-capability.yaml