HashiCorp Cloud Platform Packer Artifact RegistryStable

Packer Service

Get BuildGET/builds/{build_id}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/builds/{build_id}

Gets a build with its list of images.

Path Parameters

location.organization_id string

organization_id is the id of the organization.

location.project_id string

project_id is the projects id.

build_id string

ULID of the build that should be retrieved.

Query Parameters

location.region.provider string

provider is the named cloud provider ("aws", "gcp", "azure")

location.region.region string

region is the cloud region ("us-west1", "us-east1")

Successful Response

build object

The requested build.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the build.

iteration_id string

Unique identifier of the iteration associated with this build; this was created and set by the HCP Packer registry when the iteration was created.

component_type string

Internal Packer name for the builder or post-processor component used to build this. For example, "amazon-ebs" or "azure-arm".

packer_run_uuid string

The UUID specific to this call to Packer build. If you use the manifest post-processor, this UUID will match the UUID present there.

images object[]

Represents the actual region:image_id mapping for a single image, in a single build.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) for the image.

image_id string

ID or URL of the remote cloud image as given by a build. For example, ami-12345.

region string

Cloud-specific region as provided by packer build. For example, "ap-east-1".

created_at string

Timestamp at which this image was created.

cloud_provider string

The cloud provider that this build produced artifacts for. For example, AWS, GCP, or Azure.

status string

Status of the build. The status can be RUNNING, DONE, CANCELLED, FAILED, or UNSET.

created_at string

When the build was created.

updated_at string

When the build was most recently updated.

source_image_id string

The ID or URL of the remote cloud source image that HCP Packer uses to track image dependencies for build pipelines.

labels object

A key:value map for custom, user-settable metadata about your build.

source_build_ulid string

Unique identifier of the HCP Packer registry build that Packer uses as the source for this build. HCP Packer uses this to track dependencies for build pipelines.

Delete BuildDELETE/builds/{build_id}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/builds/{build_id}

Deletes a build in the provided iteration.

Path Parameters

location.organization_id string

organization_id is the id of the organization.

location.project_id string

project_id is the projects id.

build_id string

ULID of the build that should be deleted.

Query Parameters

location.region.provider string

provider is the named cloud provider ("aws", "gcp", "azure")

location.region.region string

region is the cloud region ("us-west1", "us-east1")

Update BuildPATCH/builds/{build_id}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/builds/{build_id}

Updates an image build. This may be most often used for modifying the status of a currently running build.

Path Parameters

location.organization_id string

organization_id is the id of the organization.

location.project_id string

project_id is the projects id.

build_id string

ULID of the build that should be updated.

Body Parameters

location object

Location represents a target for an operation in HCP.

region object

region is the region that the resource is located in. It is optional if the object being referenced is a global object.

provider string

provider is the named cloud provider ("aws", "gcp", "azure")

region string

region is the cloud region ("us-west1", "us-east1")

updates object

Information about the build you are updating.

status string

Status of the build. The status can be RUNNING, DONE, CANCELLED, FAILED, or UNSET.

cloud_provider string

The cloud provider that this build produced artifacts for. For example, AWS, GCP, or Azure.

packer_run_uuid string

The UUID specific to this call to Packer build. If you use the manifest post-processor, this UUID will match the UUID present there.

images object[]

This message is used for build/create calls; it removes elements from the Image message that the user cannot set.

image_id string

ID or URL of the remote cloud image as given by a build.

region string

Cloud-specific region as provided by packer build. For example, "ap-east-1".

labels object

A key:value map for custom, user-settable metadata about your build.

source_image_id string

The ID or URL of the remote cloud source image. Used for tracking image dependencies for build pipelines.

source_iteration_id string

The ID of the parent iteration associated with the source_image_id. When the source iteration ID is set, the source image ID should also be set.

source_channel_id string

The ID of the channel that it was used to fetch the source_iteration_id. When the source channel ID is set, the source iteration ID should also be set.

Successful Response

build object

Information about the build you updated.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the build.

iteration_id string

Unique identifier of the iteration associated with this build; this was created and set by the HCP Packer registry when the iteration was created.

component_type string

Internal Packer name for the builder or post-processor component used to build this. For example, "amazon-ebs" or "azure-arm".

packer_run_uuid string

The UUID specific to this call to Packer build. If you use the manifest post-processor, this UUID will match the UUID present there.

images object[]

Represents the actual region:image_id mapping for a single image, in a single build.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) for the image.

image_id string

ID or URL of the remote cloud image as given by a build. For example, ami-12345.

region string

Cloud-specific region as provided by packer build. For example, "ap-east-1".

created_at string

Timestamp at which this image was created.

cloud_provider string

The cloud provider that this build produced artifacts for. For example, AWS, GCP, or Azure.

status string

Status of the build. The status can be RUNNING, DONE, CANCELLED, FAILED, or UNSET.

created_at string

When the build was created.

updated_at string

When the build was most recently updated.

source_image_id string

The ID or URL of the remote cloud source image that HCP Packer uses to track image dependencies for build pipelines.

labels object

A key:value map for custom, user-settable metadata about your build.

source_build_ulid string

Unique identifier of the HCP Packer registry build that Packer uses as the source for this build. HCP Packer uses this to track dependencies for build pipelines.

List BucketsGET/images

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images

Lists every existing bucket in the HCP Packer registry and their last completed iteration.

Path Parameters

location.organization_id string

organization_id is the id of the organization.

location.project_id string

project_id is the projects id.

Query Parameters

location.region.provider string

provider is the named cloud provider ("aws", "gcp", "azure")

location.region.region string

region is the cloud region ("us-west1", "us-east1")

pagination.page_size integer

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 can be used to get the next page of results in subsequent requests. A value of zero will cause page_size to be defaulted.

pagination.next_page_token string

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. If set, previous_page_token must not be set.

pagination.previous_page_token string

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 of results. If set, next_page_token must not be set.

sorting.order_by string[]

Successful Response

buckets object[]

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the bucket.

slug string

Human-readable name for the bucket.

location object

Location represents a target for an operation in HCP.

organization_id string

organization_id is the id of the organization.

project_id string

project_id is the projects id.

region object

region is the region that the resource is located in. It is optional if the object being referenced is a global object.

provider string

provider is the named cloud provider ("aws", "gcp", "azure")

region string

region is the cloud region ("us-west1", "us-east1")

latest_iteration object

The bucket's most recent iteration. This iteration may be complete or not.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the iteration.

bucket_slug string

Human-readable name for the bucket that this iteration is associated with.

iteration_ancestor_id string

The unique identifier of the iteration that was used as a source for this iteration, if this iteration was built on a base layer. Deprecated: refer to build specific source_build_ulid.

incremental_version integer

The human-readable version number assigned to this iteration. This field will only be set if the iteration is "complete".

complete boolean

If true, all builds associated with this iteration have successfully completed and uploaded metadata to the registry. When "complete" is true, This iteration is considered ready to use, and can have channels assigned to it.

author_id string

The name of the person who created this iteration.

created_at string

When the iteration was created.

updated_at string

When the iteration was last updated.

fingerprint string

Fingerprint of the iteration. The fingerprint is set by Packer when you call packer build.

builds object[]

A simplified Build used in BucketLatestIteration to represent the builds of a bucket's latest iteration. This build representation does not contain ancestry information to avoid repetition.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the build.

iteration_id string

Unique identifier of the iteration associated with this build; this was created and set by the HCP Packer registry when the iteration was created.

component_type string

Internal Packer name for the builder or post-processor component used to build this. For example, "amazon-ebs" or "azure-arm".

packer_run_uuid string

The UUID specific to this call to Packer build. If you use the manifest post-processor, this UUID will match the UUID present there.

images object[]

Represents the actual region:image_id mapping for a single image, in a single build.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) for the image.

image_id string

ID or URL of the remote cloud image as given by a build. For example, ami-12345.

region string

Cloud-specific region as provided by packer build. For example, "ap-east-1".

created_at string

Timestamp at which this image was created.

cloud_provider string

The cloud provider that this build produced artifacts for. For example, AWS, GCP, or Azure.

status string

Status of the build. The status can be RUNNING, DONE, CANCELLED, FAILED, or UNSET.

created_at string

When the build was created.

updated_at string

When the build was most recently updated.

source_image_id string

The ID or URL of the remote cloud source image. Used for tracking image dependencies for build pipelines.

labels object

A key:value map for custom, user-settable metadata about your build.

source_build_ulid string

Unique identifier of the HCP Packer registry build used as the source for this build. Used for tracking dependencies for build pipelines.

revoke_at string

Timestamp from when the iteration is revoked an no longer trusted to be secure.

revocation_message string

A short explanation of why this iteration was revoked.

revocation_author string

Who revoked this iteration. For human authors (e.g. HCP Portal) this will be an email address. For machine authors using service principals, this is the customer-chosen name for this service principal.

revocation_type string

Revocation type is 'manual' when self revoked or 'inherited' when inherited from a revoked ancestor.

revocation_inherited_from object

The ancestor iteration from whom this iteration inherited the revocation state.

href string

The URL to get the revoked ancestor.

bucket_slug string

The revoked ancestor bucket slug.

iteration_incremental_version integer

The revoked ancestor iteration incremental version.

iteration_id string

The revoked ancestor iteration ULID.

iteration_fingerprint string

The revoked ancestor iteration fingerprint.

latest_version integer

The human-readable version of the most recent completed iteration in this bucket.

created_at string

When the bucket was created.

updated_at string

When the bucket was last updated.

platforms string[]

description string

A short description of what this bucket's images are for.

labels object

A key:value map for custom, user-settable metadata about your bucket.

iteration_count string

The total number of iterations in this bucket.

parents object

Information about this image bucket's parents. Parents are the base images Packer used to build the latest complete iteration in this image bucket.

href string

The URL to retrieve the list of ancestry relationships between this image bucket and its direct source images (parents).

status string

The overall status for all parent iterations. If at least one parent is out of date, HCP Packer reports the overall status as 'OUT_OF_DATE'.

children object

Information about this image bucket's children. Children are image buckets that used any iteration of this bucket as the base image for their latest complete iteration.

href string

The URL to retrieve the list of ancestry relationships between this image bucket and its direct children.

status string

The overall ancestry status for all child iterations. If at least one child is out of date, HCP Packer reports the overall status as 'OUT_OF_DATE'.

pagination object

Pagination tokens for a subsequent request.

next_page_token string

This token allows you to get the next page of results for list requests. If the number of results is larger than page_size, use the next_page_token as a value for the query parameter next_page_token in the next request. The value will become empty when there are no more pages.

previous_page_token string

This token allows you to get the previous page of results for list requests. If the number of results is larger than page_size, use the previous_page_token as a value for the query parameter previous_page_token in the next request. The value will become empty when there are no more pages.

Create BucketPUT/images

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images

Creates an image bucket in the HCP Packer registry.

Path Parameters

location.organization_id string

organization_id is the id of the organization.

location.project_id string

project_id is the projects id.

Body Parameters

bucket_slug string

Human-readable name for the bucket.

description string

A short description of what this bucket's images are for.

labels object

A key:value map for custom, user-settable metadata about your bucket.

location object

Location represents a target for an operation in HCP.

region object

region is the region that the resource is located in. It is optional if the object being referenced is a global object.

provider string

provider is the named cloud provider ("aws", "gcp", "azure")

region string

region is the cloud region ("us-west1", "us-east1")

Successful Response

bucket object

Information about the bucket that was created.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the bucket.

slug string

Human-readable name for the bucket.

location object

Location represents a target for an operation in HCP.

organization_id string

organization_id is the id of the organization.

project_id string

project_id is the projects id.

region object

region is the region that the resource is located in. It is optional if the object being referenced is a global object.

provider string

provider is the named cloud provider ("aws", "gcp", "azure")

region string

region is the cloud region ("us-west1", "us-east1")

latest_iteration object

The bucket's most recent iteration. This iteration may be complete or not.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the iteration.

bucket_slug string

Human-readable name for the bucket that this iteration is associated with.

iteration_ancestor_id string

The unique identifier of the iteration that was used as a source for this iteration, if this iteration was built on a base layer. Deprecated: refer to build specific source_build_ulid.

incremental_version integer

The human-readable version number assigned to this iteration. This field will only be set if the iteration is "complete".

complete boolean

author_id string

The name of the person who created this iteration.

created_at string

When the iteration was created.

updated_at string

When the iteration was last updated.

fingerprint string

Fingerprint of the iteration. The fingerprint is set by Packer when you call packer build.

builds object[]

A simplified Build used in BucketLatestIteration to represent the builds of a bucket's latest iteration. This build representation does not contain ancestry information to avoid repetition.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the build.

iteration_id string

Unique identifier of the iteration associated with this build; this was created and set by the HCP Packer registry when the iteration was created.

component_type string

Internal Packer name for the builder or post-processor component used to build this. For example, "amazon-ebs" or "azure-arm".

packer_run_uuid string

The UUID specific to this call to Packer build. If you use the manifest post-processor, this UUID will match the UUID present there.

images object[]

Represents the actual region:image_id mapping for a single image, in a single build.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) for the image.

image_id string

ID or URL of the remote cloud image as given by a build. For example, ami-12345.

region string

Cloud-specific region as provided by packer build. For example, "ap-east-1".

created_at string

Timestamp at which this image was created.

cloud_provider string

The cloud provider that this build produced artifacts for. For example, AWS, GCP, or Azure.

status string

Status of the build. The status can be RUNNING, DONE, CANCELLED, FAILED, or UNSET.

created_at string

When the build was created.

updated_at string

When the build was most recently updated.

source_image_id string

The ID or URL of the remote cloud source image. Used for tracking image dependencies for build pipelines.

labels object

A key:value map for custom, user-settable metadata about your build.

source_build_ulid string

Unique identifier of the HCP Packer registry build used as the source for this build. Used for tracking dependencies for build pipelines.

revoke_at string

Timestamp from when the iteration is revoked an no longer trusted to be secure.

revocation_message string

A short explanation of why this iteration was revoked.

revocation_author string

revocation_type string

Revocation type is 'manual' when self revoked or 'inherited' when inherited from a revoked ancestor.

revocation_inherited_from object

The ancestor iteration from whom this iteration inherited the revocation state.

href string

The URL to get the revoked ancestor.

bucket_slug string

The revoked ancestor bucket slug.

iteration_incremental_version integer

The revoked ancestor iteration incremental version.

iteration_id string

The revoked ancestor iteration ULID.

iteration_fingerprint string

The revoked ancestor iteration fingerprint.

latest_version integer

The human-readable version of the most recent completed iteration in this bucket.

created_at string

When the bucket was created.

updated_at string

When the bucket was last updated.

platforms string[]

description string

A short description of what this bucket's images are for.

labels object

A key:value map for custom, user-settable metadata about your bucket.

iteration_count string

The total number of iterations in this bucket.

parents object

Information about this image bucket's parents. Parents are the base images Packer used to build the latest complete iteration in this image bucket.

href string

The URL to retrieve the list of ancestry relationships between this image bucket and its direct source images (parents).

status string

The overall status for all parent iterations. If at least one parent is out of date, HCP Packer reports the overall status as 'OUT_OF_DATE'.

children object

Information about this image bucket's children. Children are image buckets that used any iteration of this bucket as the base image for their latest complete iteration.

href string

The URL to retrieve the list of ancestry relationships between this image bucket and its direct children.

status string

The overall ancestry status for all child iterations. If at least one child is out of date, HCP Packer reports the overall status as 'OUT_OF_DATE'.

Get BucketGET/images/{bucket_slug}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}

Gets a bucket with its latest completed iteration.

Path Parameters

location.organization_id string

organization_id is the id of the organization.

location.project_id string

project_id is the projects id.

bucket_slug string

Human-readable name for the bucket.

Query Parameters

location.region.provider string

provider is the named cloud provider ("aws", "gcp", "azure")

location.region.region string

region is the cloud region ("us-west1", "us-east1")

bucket_id string

ULID of the bucket.

Successful Response

bucket object

The requested information about the bucket.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the bucket.

slug string

Human-readable name for the bucket.

location object

Location represents a target for an operation in HCP.

organization_id string

organization_id is the id of the organization.

project_id string

project_id is the projects id.

region object

region is the region that the resource is located in. It is optional if the object being referenced is a global object.

provider string

provider is the named cloud provider ("aws", "gcp", "azure")

region string

region is the cloud region ("us-west1", "us-east1")

latest_iteration object

The bucket's most recent iteration. This iteration may be complete or not.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the iteration.

bucket_slug string

Human-readable name for the bucket that this iteration is associated with.

iteration_ancestor_id string

The unique identifier of the iteration that was used as a source for this iteration, if this iteration was built on a base layer. Deprecated: refer to build specific source_build_ulid.

incremental_version integer

The human-readable version number assigned to this iteration. This field will only be set if the iteration is "complete".

complete boolean

author_id string

The name of the person who created this iteration.

created_at string

When the iteration was created.

updated_at string

When the iteration was last updated.

fingerprint string

Fingerprint of the iteration. The fingerprint is set by Packer when you call packer build.

builds object[]

A simplified Build used in BucketLatestIteration to represent the builds of a bucket's latest iteration. This build representation does not contain ancestry information to avoid repetition.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the build.

iteration_id string

Unique identifier of the iteration associated with this build; this was created and set by the HCP Packer registry when the iteration was created.

component_type string

Internal Packer name for the builder or post-processor component used to build this. For example, "amazon-ebs" or "azure-arm".

packer_run_uuid string

The UUID specific to this call to Packer build. If you use the manifest post-processor, this UUID will match the UUID present there.

images object[]

Represents the actual region:image_id mapping for a single image, in a single build.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) for the image.

image_id string

ID or URL of the remote cloud image as given by a build. For example, ami-12345.

region string

Cloud-specific region as provided by packer build. For example, "ap-east-1".

created_at string

Timestamp at which this image was created.

cloud_provider string

The cloud provider that this build produced artifacts for. For example, AWS, GCP, or Azure.

status string

Status of the build. The status can be RUNNING, DONE, CANCELLED, FAILED, or UNSET.

created_at string

When the build was created.

updated_at string

When the build was most recently updated.

source_image_id string

The ID or URL of the remote cloud source image. Used for tracking image dependencies for build pipelines.

labels object

A key:value map for custom, user-settable metadata about your build.

source_build_ulid string

Unique identifier of the HCP Packer registry build used as the source for this build. Used for tracking dependencies for build pipelines.

revoke_at string

Timestamp from when the iteration is revoked an no longer trusted to be secure.

revocation_message string

A short explanation of why this iteration was revoked.

revocation_author string

revocation_type string

Revocation type is 'manual' when self revoked or 'inherited' when inherited from a revoked ancestor.

revocation_inherited_from object

The ancestor iteration from whom this iteration inherited the revocation state.

href string

The URL to get the revoked ancestor.

bucket_slug string

The revoked ancestor bucket slug.

iteration_incremental_version integer

The revoked ancestor iteration incremental version.

iteration_id string

The revoked ancestor iteration ULID.

iteration_fingerprint string

The revoked ancestor iteration fingerprint.

latest_version integer

The human-readable version of the most recent completed iteration in this bucket.

created_at string

When the bucket was created.

updated_at string

When the bucket was last updated.

platforms string[]

description string

A short description of what this bucket's images are for.

labels object

A key:value map for custom, user-settable metadata about your bucket.

iteration_count string

The total number of iterations in this bucket.

parents object

Information about this image bucket's parents. Parents are the base images Packer used to build the latest complete iteration in this image bucket.

href string

The URL to retrieve the list of ancestry relationships between this image bucket and its direct source images (parents).

status string

The overall status for all parent iterations. If at least one parent is out of date, HCP Packer reports the overall status as 'OUT_OF_DATE'.

children object

Information about this image bucket's children. Children are image buckets that used any iteration of this bucket as the base image for their latest complete iteration.

href string

The URL to retrieve the list of ancestry relationships between this image bucket and its direct children.

status string

The overall ancestry status for all child iterations. If at least one child is out of date, HCP Packer reports the overall status as 'OUT_OF_DATE'.

Delete BucketDELETE/images/{bucket_slug}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}

Deletes a bucket and all its information, such as iterations and builds.

Path Parameters

location.organization_id string

organization_id is the id of the organization.

location.project_id string

project_id is the projects id.

bucket_slug string

Human-readable name for the bucket.

Query Parameters

location.region.provider string

provider is the named cloud provider ("aws", "gcp", "azure")

location.region.region string

region is the cloud region ("us-west1", "us-east1")

Update BucketPATCH/images/{bucket_slug}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}

Updates a bucket's information.

Path Parameters

location.organization_id string

organization_id is the id of the organization.

location.project_id string

project_id is the projects id.

bucket_slug string

Human-readable name for the bucket.

Body Parameters

location object

Location represents a target for an operation in HCP.

region object

region is the region that the resource is located in. It is optional if the object being referenced is a global object.

provider string

provider is the named cloud provider ("aws", "gcp", "azure")

region string

region is the cloud region ("us-west1", "us-east1")

platforms string[]

description string

A short description of what this bucket's images are for.

labels object

A key:value map for custom, user-settable metadata about your bucket.

Successful Response

bucket object

Information about the bucket that was updated.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the bucket.

slug string

Human-readable name for the bucket.

location object

Location represents a target for an operation in HCP.

organization_id string

organization_id is the id of the organization.

project_id string

project_id is the projects id.

region object

region is the region that the resource is located in. It is optional if the object being referenced is a global object.

provider string

provider is the named cloud provider ("aws", "gcp", "azure")

region string

region is the cloud region ("us-west1", "us-east1")

latest_iteration object

The bucket's most recent iteration. This iteration may be complete or not.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the iteration.

bucket_slug string

Human-readable name for the bucket that this iteration is associated with.

iteration_ancestor_id string

The unique identifier of the iteration that was used as a source for this iteration, if this iteration was built on a base layer. Deprecated: refer to build specific source_build_ulid.

incremental_version integer

The human-readable version number assigned to this iteration. This field will only be set if the iteration is "complete".

complete boolean

author_id string

The name of the person who created this iteration.

created_at string

When the iteration was created.

updated_at string

When the iteration was last updated.

fingerprint string

Fingerprint of the iteration. The fingerprint is set by Packer when you call packer build.

builds object[]

A simplified Build used in BucketLatestIteration to represent the builds of a bucket's latest iteration. This build representation does not contain ancestry information to avoid repetition.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the build.

iteration_id string

Unique identifier of the iteration associated with this build; this was created and set by the HCP Packer registry when the iteration was created.

component_type string

Internal Packer name for the builder or post-processor component used to build this. For example, "amazon-ebs" or "azure-arm".

packer_run_uuid string

The UUID specific to this call to Packer build. If you use the manifest post-processor, this UUID will match the UUID present there.

images object[]

Represents the actual region:image_id mapping for a single image, in a single build.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) for the image.

image_id string

ID or URL of the remote cloud image as given by a build. For example, ami-12345.

region string

Cloud-specific region as provided by packer build. For example, "ap-east-1".

created_at string

Timestamp at which this image was created.

cloud_provider string

The cloud provider that this build produced artifacts for. For example, AWS, GCP, or Azure.

status string

Status of the build. The status can be RUNNING, DONE, CANCELLED, FAILED, or UNSET.

created_at string

When the build was created.

updated_at string

When the build was most recently updated.

source_image_id string

The ID or URL of the remote cloud source image. Used for tracking image dependencies for build pipelines.

labels object

A key:value map for custom, user-settable metadata about your build.

source_build_ulid string

Unique identifier of the HCP Packer registry build used as the source for this build. Used for tracking dependencies for build pipelines.

revoke_at string

Timestamp from when the iteration is revoked an no longer trusted to be secure.

revocation_message string

A short explanation of why this iteration was revoked.

revocation_author string

revocation_type string

Revocation type is 'manual' when self revoked or 'inherited' when inherited from a revoked ancestor.

revocation_inherited_from object

The ancestor iteration from whom this iteration inherited the revocation state.

href string

The URL to get the revoked ancestor.

bucket_slug string

The revoked ancestor bucket slug.

iteration_incremental_version integer

The revoked ancestor iteration incremental version.

iteration_id string

The revoked ancestor iteration ULID.

iteration_fingerprint string

The revoked ancestor iteration fingerprint.

latest_version integer

The human-readable version of the most recent completed iteration in this bucket.

created_at string

When the bucket was created.

updated_at string

When the bucket was last updated.

platforms string[]

description string

A short description of what this bucket's images are for.

labels object

A key:value map for custom, user-settable metadata about your bucket.

iteration_count string

The total number of iterations in this bucket.

parents object

Information about this image bucket's parents. Parents are the base images Packer used to build the latest complete iteration in this image bucket.

href string

The URL to retrieve the list of ancestry relationships between this image bucket and its direct source images (parents).

status string

The overall status for all parent iterations. If at least one parent is out of date, HCP Packer reports the overall status as 'OUT_OF_DATE'.

children object

Information about this image bucket's children. Children are image buckets that used any iteration of this bucket as the base image for their latest complete iteration.

href string

The URL to retrieve the list of ancestry relationships between this image bucket and its direct children.

status string

The overall ancestry status for all child iterations. If at least one child is out of date, HCP Packer reports the overall status as 'OUT_OF_DATE'.

List Bucket AncestryGET/images/{bucket_slug}/ancestry

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/ancestry

Lists the ancestry relationships for an image bucket. This includes direct source images (parents) and downstream images built directly from the image bucket (children).

Path Parameters

location.organization_id string

organization_id is the id of the organization.

location.project_id string

project_id is the projects id.

bucket_slug string

Human-readable name for the bucket you want to list ancestry for.

Query Parameters

location.region.provider string

provider is the named cloud provider ("aws", "gcp", "azure")

location.region.region string

region is the cloud region ("us-west1", "us-east1")

type string

The type of ancestry relations to list. Type 'parents' lists all the direct source images for this image bucket. Type 'children' lists all of the child images built directly from this image bucket. If not specified, defaults to listing both parent and child relationships for the image bucket.

channel string

An image channel in the image bucket associated with the request. This property filters the results to children whose parent iteration was assigned to this channel when the children were built. If not specified, the endpoint returns all children built from any iteration in this image bucket.

pagination.page_size integer

pagination.next_page_token string

pagination.previous_page_token string

incremental_version integer

The human-readable version number of an iteration that HCP Packer uses to list that iteration's parents. All parents are the parent images Packer used to build this iteration. If not specified, the endpoint returns the parents of the image bucket's latest iteration.

iteration_id string

ULID of the iteration that HCP Packer uses to list that iteration's parents. All parents are the parent images Packer used to build this iteration. If not specified, the endpoint returns the parents of the image bucket's latest iteration.

fingerprint string

Fingerprint of an iteration that HCP Packer uses to list that iteration's parents. All parents are the parent images Packer used to build this iteration. If not specified, the endpoint returns the parents of the image bucket's latest iteration.

Successful Response

relations object[]

The parent-child relationship between two image buckets.

status string

The status of the relationship between the parent and child buckets.

parent object

The parent image bucket and iteration that relates to the child image bucket's latest iteration.

bucket_slug string

The parent bucket slug.

iteration_id string

The parent iteration ULID.

iteration_incremental_version integer

The parent iteration incremental version.

iteration_fingerprint string

The parent iteration fingerprint.

channel string

The image channel associated with this relationship.

channel_iteration object

The iteration currently assigned to the channel associated with the ancestry relationship.

id string

The currently assigned iteration's ULID.

incremental_version integer

The currently assigned iteration's incremental version.

fingerprint string

The currently assigned iteration's build fingerprint.

child object

The child image bucket and the iteration in that image bucket that relates to the parent.

bucket_slug string

The child image bucket's slug.

iteration_id string

The child iteration's ULID.

iteration_incremental_version integer

The child iteration's incremental version.

iteration_fingerprint string

The child iteration's build fingerprint.

total_count integer

The total number of ancestral relationships returned for the specified image bucket. These can be parent or child images.

pagination object

PaginationResponse is the response holding the page tokens for a paginated list response.

next_page_token string

previous_page_token string

List ChannelsGET/images/{bucket_slug}/channels

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/channels

Lists all channels of a given bucket.

Path Parameters

location.organization_id string

organization_id is the id of the organization.

location.project_id string

project_id is the projects id.

bucket_slug string

Human-readable name for the bucket you want to list channels for.

Query Parameters

location.region.provider string

provider is the named cloud provider ("aws", "gcp", "azure")

location.region.region string

region is the cloud region ("us-west1", "us-east1")

Successful Response

channels object[]

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the channel.

slug string

Human-readable name for the channel.

bucket_slug string

Human-readable name for the bucket this channel is associated with.

author_id string

The user who last updated the channel.

created_at string

When the channel was created.

pointer object

A pointer to the iteration currently associated with this channel. Deprecated: look at the Channel.iteration instead.

iteration object

The iteration the channel is pointing to.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the iteration.

bucket_slug string

Human-readable name for the bucket that this iteration is associated with.

iteration_ancestor_id string

The unique identifier of the iteration that was used as a source for this iteration, if this iteration was built on a base layer. Deprecated: refer to build specific source_build_ulid.

incremental_version integer

The human-readable version number assigned to this iteration. This field will only be set if the iteration is "complete".

complete boolean

author_id string

The name of the person who created this iteration.

created_at string

When the iteration was created.

updated_at string

When the iteration was last updated.

fingerprint string

Fingerprint of the iteration. The fingerprint is set by Packer when you call packer build.

builds object[]

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the build.

iteration_id string

Unique identifier of the iteration associated with this build; this was created and set by the HCP Packer registry when the iteration was created.

component_type string

Internal Packer name for the builder or post-processor component used to build this. For example, "amazon-ebs" or "azure-arm".

packer_run_uuid string

The UUID specific to this call to Packer build. If you use the manifest post-processor, this UUID will match the UUID present there.

images object[]

Represents the actual region:image_id mapping for a single image, in a single build.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) for the image.

image_id string

ID or URL of the remote cloud image as given by a build. For example, ami-12345.

region string

Cloud-specific region as provided by packer build. For example, "ap-east-1".

created_at string

Timestamp at which this image was created.

cloud_provider string

The cloud provider that this build produced artifacts for. For example, AWS, GCP, or Azure.

status string

Status of the build. The status can be RUNNING, DONE, CANCELLED, FAILED, or UNSET.

created_at string

When the build was created.

updated_at string

When the build was most recently updated.

source_image_id string

The ID or URL of the remote cloud source image that HCP Packer uses to track image dependencies for build pipelines.

labels object

A key:value map for custom, user-settable metadata about your build.

source_build_ulid string

Unique identifier of the HCP Packer registry build that Packer uses as the source for this build. HCP Packer uses this to track dependencies for build pipelines.

revoke_at string

Timestamp from when the iteration is revoked an no longer trusted to be secure.

revocation_message string

A short explanation of why this iteration was revoked.

revocation_author string

revocation_type string

Revocation type is 'manual' when the iteration is revoked directly or 'inherited' when the iteration inherits a revocation from an upstream ancestor.

revocation_inherited_from object

The ancestor iteration from whom this iteration inherited the revocation.

href string

The URL to get the revoked ancestor.

bucket_slug string

The revoked ancestor bucket slug.

iteration_incremental_version integer

The revoked ancestor iteration incremental version.

iteration_id string

The revoked ancestor iteration ULID.

iteration_fingerprint string

The revoked ancestor iteration fingerprint.

has_descendants boolean

If true, this iteration has children iterations. Knowing if an iteration has descendants can help taking decisions such as persist revocation to all its descendants or not.

template_type string

TEMPLATE_TYPE_UNSET: TEMPLATE_TYPE_UNSET is a sentinel zero value so that an uninitialized value can be detected.
HCL2: HCL2 configuration template; either pkr.hcl or pkr.json
JSON: Legacy JSON configuration template

The type of Packer configuration template used to build this iteration.

author_id string

The user who pointed the channel to the iteration.

created_at string

When the channel pointer was created.

updated_at string

When the channel was last updated.

iteration object

The iteration the channel is pointing to.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the iteration.

bucket_slug string

Human-readable name for the bucket that this iteration is associated with.

iteration_ancestor_id string

The unique identifier of the iteration that was used as a source for this iteration, if this iteration was built on a base layer. Deprecated: refer to build specific source_build_ulid.

incremental_version integer

The human-readable version number assigned to this iteration. This field will only be set if the iteration is "complete".

complete boolean

author_id string

The name of the person who created this iteration.

created_at string

When the iteration was created.

updated_at string

When the iteration was last updated.

fingerprint string

Fingerprint of the iteration. The fingerprint is set by Packer when you call packer build.

builds object[]

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the build.

iteration_id string

Unique identifier of the iteration associated with this build; this was created and set by the HCP Packer registry when the iteration was created.

component_type string

Internal Packer name for the builder or post-processor component used to build this. For example, "amazon-ebs" or "azure-arm".

packer_run_uuid string

The UUID specific to this call to Packer build. If you use the manifest post-processor, this UUID will match the UUID present there.

images object[]

Represents the actual region:image_id mapping for a single image, in a single build.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) for the image.

image_id string

ID or URL of the remote cloud image as given by a build. For example, ami-12345.

region string

Cloud-specific region as provided by packer build. For example, "ap-east-1".

created_at string

Timestamp at which this image was created.

cloud_provider string

The cloud provider that this build produced artifacts for. For example, AWS, GCP, or Azure.

status string

Status of the build. The status can be RUNNING, DONE, CANCELLED, FAILED, or UNSET.

created_at string

When the build was created.

updated_at string

When the build was most recently updated.

source_image_id string

The ID or URL of the remote cloud source image that HCP Packer uses to track image dependencies for build pipelines.

labels object

A key:value map for custom, user-settable metadata about your build.

source_build_ulid string

Unique identifier of the HCP Packer registry build that Packer uses as the source for this build. HCP Packer uses this to track dependencies for build pipelines.

revoke_at string

Timestamp from when the iteration is revoked an no longer trusted to be secure.

revocation_message string

A short explanation of why this iteration was revoked.

revocation_author string

revocation_type string

Revocation type is 'manual' when the iteration is revoked directly or 'inherited' when the iteration inherits a revocation from an upstream ancestor.

revocation_inherited_from object

The ancestor iteration from whom this iteration inherited the revocation.

href string

The URL to get the revoked ancestor.

bucket_slug string

The revoked ancestor bucket slug.

iteration_incremental_version integer

The revoked ancestor iteration incremental version.

iteration_id string

The revoked ancestor iteration ULID.

iteration_fingerprint string

The revoked ancestor iteration fingerprint.

has_descendants boolean

If true, this iteration has children iterations. Knowing if an iteration has descendants can help taking decisions such as persist revocation to all its descendants or not.

template_type string

TEMPLATE_TYPE_UNSET: TEMPLATE_TYPE_UNSET is a sentinel zero value so that an uninitialized value can be detected.
HCL2: HCL2 configuration template; either pkr.hcl or pkr.json
JSON: Legacy JSON configuration template

The type of Packer configuration template used to build this iteration.

managed boolean

If the channel is managed by HCP Packer (such as the latest channel).

restricted boolean

Whether this channel's access is restricted to users of the organization with permission to create and manage resources.

Create ChannelPOST/images/{bucket_slug}/channels

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/channels

Creates a channel either empty or assigned to an iteration.

Path Parameters

location.organization_id string

organization_id is the id of the organization.

location.project_id string

project_id is the projects id.

bucket_slug string

Human-readable name for the bucket to associate the channel with.

Body Parameters

slug string

Human-readable name for the channel.

incremental_version integer

The human-readable version number assigned to this iteration.

iteration_id string

ULID of the iteration.

fingerprint string

Fingerprint of the iteration set by Packer when you call packer build. Refer to the Packer documentation for more information on how this value is set. The fingerprint can be used as an identifier for the iteration.

location object

Location represents a target for an operation in HCP.

region object

region is the region that the resource is located in. It is optional if the object being referenced is a global object.

provider string

provider is the named cloud provider ("aws", "gcp", "azure")

region string

region is the cloud region ("us-west1", "us-east1")

restriction string

When set, will set the channel access in HCP Packer registry. The channel is unrestricted by default;

RESTRICTED: Make the channel only visible to users with permission to create and manage.
UNRESTRICTED: Make the channel visible to every member of this organization.

Successful Response

channel object

Information about the channel that was created.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the channel.

slug string

Human-readable name for the channel.

bucket_slug string

Human-readable name for the bucket this channel is associated with.

author_id string

The user who last updated the channel.

created_at string

When the channel was created.

pointer object

A pointer to the iteration currently associated with this channel. Deprecated: look at the Channel.iteration instead.

iteration object

The iteration the channel is pointing to.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the iteration.

bucket_slug string

Human-readable name for the bucket that this iteration is associated with.

iteration_ancestor_id string

The unique identifier of the iteration that was used as a source for this iteration, if this iteration was built on a base layer. Deprecated: refer to build specific source_build_ulid.

incremental_version integer

The human-readable version number assigned to this iteration. This field will only be set if the iteration is "complete".

complete boolean

author_id string

The name of the person who created this iteration.

created_at string

When the iteration was created.

updated_at string

When the iteration was last updated.

fingerprint string

Fingerprint of the iteration. The fingerprint is set by Packer when you call packer build.

builds object[]

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the build.

iteration_id string

Unique identifier of the iteration associated with this build; this was created and set by the HCP Packer registry when the iteration was created.

component_type string

Internal Packer name for the builder or post-processor component used to build this. For example, "amazon-ebs" or "azure-arm".

packer_run_uuid string

The UUID specific to this call to Packer build. If you use the manifest post-processor, this UUID will match the UUID present there.

images object[]

Represents the actual region:image_id mapping for a single image, in a single build.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) for the image.

image_id string

ID or URL of the remote cloud image as given by a build. For example, ami-12345.

region string

Cloud-specific region as provided by packer build. For example, "ap-east-1".

created_at string

Timestamp at which this image was created.

cloud_provider string

The cloud provider that this build produced artifacts for. For example, AWS, GCP, or Azure.

status string

Status of the build. The status can be RUNNING, DONE, CANCELLED, FAILED, or UNSET.

created_at string

When the build was created.

updated_at string

When the build was most recently updated.

source_image_id string

The ID or URL of the remote cloud source image that HCP Packer uses to track image dependencies for build pipelines.

labels object

A key:value map for custom, user-settable metadata about your build.

source_build_ulid string

Unique identifier of the HCP Packer registry build that Packer uses as the source for this build. HCP Packer uses this to track dependencies for build pipelines.

revoke_at string

Timestamp from when the iteration is revoked an no longer trusted to be secure.

revocation_message string

A short explanation of why this iteration was revoked.

revocation_author string

revocation_type string

Revocation type is 'manual' when the iteration is revoked directly or 'inherited' when the iteration inherits a revocation from an upstream ancestor.

revocation_inherited_from object

The ancestor iteration from whom this iteration inherited the revocation.

href string

The URL to get the revoked ancestor.

bucket_slug string

The revoked ancestor bucket slug.

iteration_incremental_version integer

The revoked ancestor iteration incremental version.

iteration_id string

The revoked ancestor iteration ULID.

iteration_fingerprint string

The revoked ancestor iteration fingerprint.

has_descendants boolean

If true, this iteration has children iterations. Knowing if an iteration has descendants can help taking decisions such as persist revocation to all its descendants or not.

template_type string

TEMPLATE_TYPE_UNSET: TEMPLATE_TYPE_UNSET is a sentinel zero value so that an uninitialized value can be detected.
HCL2: HCL2 configuration template; either pkr.hcl or pkr.json
JSON: Legacy JSON configuration template

The type of Packer configuration template used to build this iteration.

author_id string

The user who pointed the channel to the iteration.

created_at string

When the channel pointer was created.

updated_at string

When the channel was last updated.

iteration object

The iteration the channel is pointing to.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the iteration.

bucket_slug string

Human-readable name for the bucket that this iteration is associated with.

iteration_ancestor_id string

The unique identifier of the iteration that was used as a source for this iteration, if this iteration was built on a base layer. Deprecated: refer to build specific source_build_ulid.

incremental_version integer

The human-readable version number assigned to this iteration. This field will only be set if the iteration is "complete".

complete boolean

author_id string

The name of the person who created this iteration.

created_at string

When the iteration was created.

updated_at string

When the iteration was last updated.

fingerprint string

Fingerprint of the iteration. The fingerprint is set by Packer when you call packer build.

builds object[]

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the build.

iteration_id string

Unique identifier of the iteration associated with this build; this was created and set by the HCP Packer registry when the iteration was created.

component_type string

Internal Packer name for the builder or post-processor component used to build this. For example, "amazon-ebs" or "azure-arm".

packer_run_uuid string

The UUID specific to this call to Packer build. If you use the manifest post-processor, this UUID will match the UUID present there.

images object[]

Represents the actual region:image_id mapping for a single image, in a single build.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) for the image.

image_id string

ID or URL of the remote cloud image as given by a build. For example, ami-12345.

region string

Cloud-specific region as provided by packer build. For example, "ap-east-1".

created_at string

Timestamp at which this image was created.

cloud_provider string

The cloud provider that this build produced artifacts for. For example, AWS, GCP, or Azure.

status string

Status of the build. The status can be RUNNING, DONE, CANCELLED, FAILED, or UNSET.

created_at string

When the build was created.

updated_at string

When the build was most recently updated.

source_image_id string

The ID or URL of the remote cloud source image that HCP Packer uses to track image dependencies for build pipelines.

labels object

A key:value map for custom, user-settable metadata about your build.

source_build_ulid string

Unique identifier of the HCP Packer registry build that Packer uses as the source for this build. HCP Packer uses this to track dependencies for build pipelines.

revoke_at string

Timestamp from when the iteration is revoked an no longer trusted to be secure.

revocation_message string

A short explanation of why this iteration was revoked.

revocation_author string

revocation_type string

Revocation type is 'manual' when the iteration is revoked directly or 'inherited' when the iteration inherits a revocation from an upstream ancestor.

revocation_inherited_from object

The ancestor iteration from whom this iteration inherited the revocation.

href string

The URL to get the revoked ancestor.

bucket_slug string

The revoked ancestor bucket slug.

iteration_incremental_version integer

The revoked ancestor iteration incremental version.

iteration_id string

The revoked ancestor iteration ULID.

iteration_fingerprint string

The revoked ancestor iteration fingerprint.

has_descendants boolean

If true, this iteration has children iterations. Knowing if an iteration has descendants can help taking decisions such as persist revocation to all its descendants or not.

template_type string

TEMPLATE_TYPE_UNSET: TEMPLATE_TYPE_UNSET is a sentinel zero value so that an uninitialized value can be detected.
HCL2: HCL2 configuration template; either pkr.hcl or pkr.json
JSON: Legacy JSON configuration template

The type of Packer configuration template used to build this iteration.

managed boolean

If the channel is managed by HCP Packer (such as the latest channel).

restricted boolean

Whether this channel's access is restricted to users of the organization with permission to create and manage resources.

Get ChannelGET/images/{bucket_slug}/channels/{slug}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/channels/{slug}

Gets a channel with the iteration that it is currently assigned if any.

Path Parameters

location.organization_id string

organization_id is the id of the organization.

location.project_id string

project_id is the projects id.

bucket_slug string

Human-readable name for the bucket that the channel is associated with.

slug string

Human-readable name for the channel.

Query Parameters

location.region.provider string

provider is the named cloud provider ("aws", "gcp", "azure")

location.region.region string

region is the cloud region ("us-west1", "us-east1")

Successful Response

channel object

The requested channel information.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the channel.

slug string

Human-readable name for the channel.

bucket_slug string

Human-readable name for the bucket this channel is associated with.

author_id string

The user who last updated the channel.

created_at string

When the channel was created.

pointer object

A pointer to the iteration currently associated with this channel. Deprecated: look at the Channel.iteration instead.

iteration object

The iteration the channel is pointing to.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the iteration.

bucket_slug string

Human-readable name for the bucket that this iteration is associated with.

iteration_ancestor_id string

The unique identifier of the iteration that was used as a source for this iteration, if this iteration was built on a base layer. Deprecated: refer to build specific source_build_ulid.

incremental_version integer

The human-readable version number assigned to this iteration. This field will only be set if the iteration is "complete".

complete boolean

author_id string

The name of the person who created this iteration.

created_at string

When the iteration was created.

updated_at string

When the iteration was last updated.

fingerprint string

Fingerprint of the iteration. The fingerprint is set by Packer when you call packer build.

builds object[]

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the build.

iteration_id string

Unique identifier of the iteration associated with this build; this was created and set by the HCP Packer registry when the iteration was created.

component_type string

Internal Packer name for the builder or post-processor component used to build this. For example, "amazon-ebs" or "azure-arm".

packer_run_uuid string

The UUID specific to this call to Packer build. If you use the manifest post-processor, this UUID will match the UUID present there.

images object[]

Represents the actual region:image_id mapping for a single image, in a single build.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) for the image.

image_id string

ID or URL of the remote cloud image as given by a build. For example, ami-12345.

region string

Cloud-specific region as provided by packer build. For example, "ap-east-1".

created_at string

Timestamp at which this image was created.

cloud_provider string

The cloud provider that this build produced artifacts for. For example, AWS, GCP, or Azure.

status string

Status of the build. The status can be RUNNING, DONE, CANCELLED, FAILED, or UNSET.

created_at string

When the build was created.

updated_at string

When the build was most recently updated.

source_image_id string

The ID or URL of the remote cloud source image that HCP Packer uses to track image dependencies for build pipelines.

labels object

A key:value map for custom, user-settable metadata about your build.

source_build_ulid string

Unique identifier of the HCP Packer registry build that Packer uses as the source for this build. HCP Packer uses this to track dependencies for build pipelines.

revoke_at string

Timestamp from when the iteration is revoked an no longer trusted to be secure.

revocation_message string

A short explanation of why this iteration was revoked.

revocation_author string

revocation_type string

Revocation type is 'manual' when the iteration is revoked directly or 'inherited' when the iteration inherits a revocation from an upstream ancestor.

revocation_inherited_from object

The ancestor iteration from whom this iteration inherited the revocation.

href string

The URL to get the revoked ancestor.

bucket_slug string

The revoked ancestor bucket slug.

iteration_incremental_version integer

The revoked ancestor iteration incremental version.

iteration_id string

The revoked ancestor iteration ULID.

iteration_fingerprint string

The revoked ancestor iteration fingerprint.

has_descendants boolean

If true, this iteration has children iterations. Knowing if an iteration has descendants can help taking decisions such as persist revocation to all its descendants or not.

template_type string

TEMPLATE_TYPE_UNSET: TEMPLATE_TYPE_UNSET is a sentinel zero value so that an uninitialized value can be detected.
HCL2: HCL2 configuration template; either pkr.hcl or pkr.json
JSON: Legacy JSON configuration template

The type of Packer configuration template used to build this iteration.

author_id string

The user who pointed the channel to the iteration.

created_at string

When the channel pointer was created.

updated_at string

When the channel was last updated.

iteration object

The iteration the channel is pointing to.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the iteration.

bucket_slug string

Human-readable name for the bucket that this iteration is associated with.

iteration_ancestor_id string

The unique identifier of the iteration that was used as a source for this iteration, if this iteration was built on a base layer. Deprecated: refer to build specific source_build_ulid.

incremental_version integer

The human-readable version number assigned to this iteration. This field will only be set if the iteration is "complete".

complete boolean

author_id string

The name of the person who created this iteration.

created_at string

When the iteration was created.

updated_at string

When the iteration was last updated.

fingerprint string

Fingerprint of the iteration. The fingerprint is set by Packer when you call packer build.

builds object[]

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the build.

iteration_id string

Unique identifier of the iteration associated with this build; this was created and set by the HCP Packer registry when the iteration was created.

component_type string

Internal Packer name for the builder or post-processor component used to build this. For example, "amazon-ebs" or "azure-arm".

packer_run_uuid string

The UUID specific to this call to Packer build. If you use the manifest post-processor, this UUID will match the UUID present there.

images object[]

Represents the actual region:image_id mapping for a single image, in a single build.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) for the image.

image_id string

ID or URL of the remote cloud image as given by a build. For example, ami-12345.

region string

Cloud-specific region as provided by packer build. For example, "ap-east-1".

created_at string

Timestamp at which this image was created.

cloud_provider string

The cloud provider that this build produced artifacts for. For example, AWS, GCP, or Azure.

status string

Status of the build. The status can be RUNNING, DONE, CANCELLED, FAILED, or UNSET.

created_at string

When the build was created.

updated_at string

When the build was most recently updated.

source_image_id string

The ID or URL of the remote cloud source image that HCP Packer uses to track image dependencies for build pipelines.

labels object

A key:value map for custom, user-settable metadata about your build.

source_build_ulid string

Unique identifier of the HCP Packer registry build that Packer uses as the source for this build. HCP Packer uses this to track dependencies for build pipelines.

revoke_at string

Timestamp from when the iteration is revoked an no longer trusted to be secure.

revocation_message string

A short explanation of why this iteration was revoked.

revocation_author string

revocation_type string

Revocation type is 'manual' when the iteration is revoked directly or 'inherited' when the iteration inherits a revocation from an upstream ancestor.

revocation_inherited_from object

The ancestor iteration from whom this iteration inherited the revocation.

href string

The URL to get the revoked ancestor.

bucket_slug string

The revoked ancestor bucket slug.

iteration_incremental_version integer

The revoked ancestor iteration incremental version.

iteration_id string

The revoked ancestor iteration ULID.

iteration_fingerprint string

The revoked ancestor iteration fingerprint.

has_descendants boolean

If true, this iteration has children iterations. Knowing if an iteration has descendants can help taking decisions such as persist revocation to all its descendants or not.

template_type string

TEMPLATE_TYPE_UNSET: TEMPLATE_TYPE_UNSET is a sentinel zero value so that an uninitialized value can be detected.
HCL2: HCL2 configuration template; either pkr.hcl or pkr.json
JSON: Legacy JSON configuration template

The type of Packer configuration template used to build this iteration.

managed boolean

If the channel is managed by HCP Packer (such as the latest channel).

restricted boolean

Whether this channel's access is restricted to users of the organization with permission to create and manage resources.

Delete ChannelDELETE/images/{bucket_slug}/channels/{slug}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/channels/{slug}

Deletes a channel.

Path Parameters

location.organization_id string

organization_id is the id of the organization.

location.project_id string

project_id is the projects id.

bucket_slug string

Human-readable name for the bucket that the channel is associated with.

slug string

Human-readable name for the channel.

Query Parameters

location.region.provider string

provider is the named cloud provider ("aws", "gcp", "azure")

location.region.region string

region is the cloud region ("us-west1", "us-east1")

Update ChannelPATCH/images/{bucket_slug}/channels/{slug}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/channels/{slug}

Updates a channel to clear or point to a new iteration.

Path Parameters

location.organization_id string

organization_id is the id of the organization.

location.project_id string

project_id is the projects id.

bucket_slug string

Human-readable name for the bucket that the channel is associated with.

slug string

Human-readable name for the channel.

Body Parameters

incremental_version integer

The human-readable version number assigned to this iteration.

iteration_id string

ULID of the iteration. This was created and set by the HCP Packer registry when the iteration was created.

fingerprint string

location object

Location represents a target for an operation in HCP.

region object

region is the region that the resource is located in. It is optional if the object being referenced is a global object.

provider string

provider is the named cloud provider ("aws", "gcp", "azure")

region string

region is the cloud region ("us-west1", "us-east1")

restriction string

When set, will set the channel access in HCP Packer registry. The channel is unrestricted by default;

RESTRICTED: Make the channel only visible to users with permission to create and manage.
UNRESTRICTED: Make the channel visible to every member of this organization.

mask string

When set, the service will only update the channel with attributes listed in the mask. For an empty mask list, all attributes will be updated according to their given value.

One or more of the iteration identifiers can be listed when updating the channel assignment. In this case, if paths for multiple iteration identifiers are present in the mask, the values of the equivalent fields must belong to the same iteration. NOTE: This is different from the behavior without a mask or with an empty mask, where the first non-zero identifier (in the order iterationId, fingerprint, incrementalVersion) is the only identifier used, and others are ignored.

Examples of usage:

"incrementalVersion,iterationId,fingerprint"
"restriction"
"restriction,iterationId"

Successful Response

channel object

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the channel.

slug string

Human-readable name for the channel.

bucket_slug string

Human-readable name for the bucket this channel is associated with.

author_id string

The user who last updated the channel.

created_at string

When the channel was created.

pointer object

A pointer to the iteration currently associated with this channel. Deprecated: look at the Channel.iteration instead.

iteration object

The iteration the channel is pointing to.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the iteration.

bucket_slug string

Human-readable name for the bucket that this iteration is associated with.

iteration_ancestor_id string

The unique identifier of the iteration that was used as a source for this iteration, if this iteration was built on a base layer. Deprecated: refer to build specific source_build_ulid.

incremental_version integer

The human-readable version number assigned to this iteration. This field will only be set if the iteration is "complete".

complete boolean

author_id string

The name of the person who created this iteration.

created_at string

When the iteration was created.

updated_at string

When the iteration was last updated.

fingerprint string

Fingerprint of the iteration. The fingerprint is set by Packer when you call packer build.

builds object[]

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the build.

iteration_id string

Unique identifier of the iteration associated with this build; this was created and set by the HCP Packer registry when the iteration was created.

component_type string

Internal Packer name for the builder or post-processor component used to build this. For example, "amazon-ebs" or "azure-arm".

packer_run_uuid string

The UUID specific to this call to Packer build. If you use the manifest post-processor, this UUID will match the UUID present there.

images object[]

Represents the actual region:image_id mapping for a single image, in a single build.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) for the image.

image_id string

ID or URL of the remote cloud image as given by a build. For example, ami-12345.

region string

Cloud-specific region as provided by packer build. For example, "ap-east-1".

created_at string

Timestamp at which this image was created.

cloud_provider string

The cloud provider that this build produced artifacts for. For example, AWS, GCP, or Azure.

status string

Status of the build. The status can be RUNNING, DONE, CANCELLED, FAILED, or UNSET.

created_at string

When the build was created.

updated_at string

When the build was most recently updated.

source_image_id string

The ID or URL of the remote cloud source image that HCP Packer uses to track image dependencies for build pipelines.

labels object

A key:value map for custom, user-settable metadata about your build.

source_build_ulid string

Unique identifier of the HCP Packer registry build that Packer uses as the source for this build. HCP Packer uses this to track dependencies for build pipelines.

revoke_at string

Timestamp from when the iteration is revoked an no longer trusted to be secure.

revocation_message string

A short explanation of why this iteration was revoked.

revocation_author string

revocation_type string

Revocation type is 'manual' when the iteration is revoked directly or 'inherited' when the iteration inherits a revocation from an upstream ancestor.

revocation_inherited_from object

The ancestor iteration from whom this iteration inherited the revocation.

href string

The URL to get the revoked ancestor.

bucket_slug string

The revoked ancestor bucket slug.

iteration_incremental_version integer

The revoked ancestor iteration incremental version.

iteration_id string

The revoked ancestor iteration ULID.

iteration_fingerprint string

The revoked ancestor iteration fingerprint.

has_descendants boolean

If true, this iteration has children iterations. Knowing if an iteration has descendants can help taking decisions such as persist revocation to all its descendants or not.

template_type string

TEMPLATE_TYPE_UNSET: TEMPLATE_TYPE_UNSET is a sentinel zero value so that an uninitialized value can be detected.
HCL2: HCL2 configuration template; either pkr.hcl or pkr.json
JSON: Legacy JSON configuration template

The type of Packer configuration template used to build this iteration.

author_id string

The user who pointed the channel to the iteration.

created_at string

When the channel pointer was created.

updated_at string

When the channel was last updated.

iteration object

The iteration the channel is pointing to.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the iteration.

bucket_slug string

Human-readable name for the bucket that this iteration is associated with.

iteration_ancestor_id string

The unique identifier of the iteration that was used as a source for this iteration, if this iteration was built on a base layer. Deprecated: refer to build specific source_build_ulid.

incremental_version integer

The human-readable version number assigned to this iteration. This field will only be set if the iteration is "complete".

complete boolean

author_id string

The name of the person who created this iteration.

created_at string

When the iteration was created.

updated_at string

When the iteration was last updated.

fingerprint string

Fingerprint of the iteration. The fingerprint is set by Packer when you call packer build.

builds object[]

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the build.

iteration_id string

Unique identifier of the iteration associated with this build; this was created and set by the HCP Packer registry when the iteration was created.

component_type string

Internal Packer name for the builder or post-processor component used to build this. For example, "amazon-ebs" or "azure-arm".

packer_run_uuid string

The UUID specific to this call to Packer build. If you use the manifest post-processor, this UUID will match the UUID present there.

images object[]

Represents the actual region:image_id mapping for a single image, in a single build.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) for the image.

image_id string

ID or URL of the remote cloud image as given by a build. For example, ami-12345.

region string

Cloud-specific region as provided by packer build. For example, "ap-east-1".

created_at string

Timestamp at which this image was created.

cloud_provider string

The cloud provider that this build produced artifacts for. For example, AWS, GCP, or Azure.

status string

Status of the build. The status can be RUNNING, DONE, CANCELLED, FAILED, or UNSET.

created_at string

When the build was created.

updated_at string

When the build was most recently updated.

source_image_id string

The ID or URL of the remote cloud source image that HCP Packer uses to track image dependencies for build pipelines.

labels object

A key:value map for custom, user-settable metadata about your build.

source_build_ulid string

Unique identifier of the HCP Packer registry build that Packer uses as the source for this build. HCP Packer uses this to track dependencies for build pipelines.

revoke_at string

Timestamp from when the iteration is revoked an no longer trusted to be secure.

revocation_message string

A short explanation of why this iteration was revoked.

revocation_author string

revocation_type string

Revocation type is 'manual' when the iteration is revoked directly or 'inherited' when the iteration inherits a revocation from an upstream ancestor.

revocation_inherited_from object

The ancestor iteration from whom this iteration inherited the revocation.

href string

The URL to get the revoked ancestor.

bucket_slug string

The revoked ancestor bucket slug.

iteration_incremental_version integer

The revoked ancestor iteration incremental version.

iteration_id string

The revoked ancestor iteration ULID.

iteration_fingerprint string

The revoked ancestor iteration fingerprint.

has_descendants boolean

If true, this iteration has children iterations. Knowing if an iteration has descendants can help taking decisions such as persist revocation to all its descendants or not.

template_type string

TEMPLATE_TYPE_UNSET: TEMPLATE_TYPE_UNSET is a sentinel zero value so that an uninitialized value can be detected.
HCL2: HCL2 configuration template; either pkr.hcl or pkr.json
JSON: Legacy JSON configuration template

The type of Packer configuration template used to build this iteration.

managed boolean

If the channel is managed by HCP Packer (such as the latest channel).

restricted boolean

Whether this channel's access is restricted to users of the organization with permission to create and manage resources.

List Channel HistoryGET/images/{bucket_slug}/channels/{slug}/history

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/channels/{slug}/history

Lists a channel assignment history.

Path Parameters

location.organization_id string

organization_id is the id of the organization.

location.project_id string

project_id is the projects id.

bucket_slug string

Human-readable name for the bucket that the channel is associated with.

slug string

Human-readable name for the channel.

Query Parameters

location.region.provider string

provider is the named cloud provider ("aws", "gcp", "azure")

location.region.region string

region is the cloud region ("us-west1", "us-east1")

pagination.page_size integer

pagination.next_page_token string

pagination.previous_page_token string

Successful Response

history object[]

A channel assignment history entry. It contains information about when an iteration was assigned to a channel, and the user who did the assignment.

iteration object

The assigned iteration.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the iteration.

incremental_version integer

The human-readable version number assigned to this iteration. This field will only be set if the iteration is "complete".

fingerprint string

Fingerprint of the iteration. The fingerprint is set by Packer when you call packer build.

status string

The current state of the iteration.

parents object

Information about this iteration's parents. Parents are the base images Packer used to build this iteration.

href string

The endpoint URL for the bucket's ancestry at this iteration.

status string

The parents' overall status for the bucket's ancestry at this iteration. If at least one parent is out of date, the overall status will be 'OUT_OF_DATE'.

author_id string

The user who assigned this iteration.

promoted_at string

When the iteration assigment happened.

count integer

The total amount of channel assignments that are listed

pagination object

PaginationResponse is the response holding the page tokens for a paginated list response.

next_page_token string

previous_page_token string

Get IterationGET/images/{bucket_slug}/iteration

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/iteration

Allows the user to get an iteration using one of the following identifiers:

iteration_id
incremental_version
fingerprint These are supplied as a query parameter (e.g. images/{bucket_slug}/iteration?fingerprint={fingerprint}).

Path Parameters

location.organization_id string

organization_id is the id of the organization.

location.project_id string

project_id is the projects id.

bucket_slug string

Human-readable name for the bucket.

Query Parameters

location.region.provider string

provider is the named cloud provider ("aws", "gcp", "azure")

location.region.region string

region is the cloud region ("us-west1", "us-east1")

incremental_version integer

The human-readable version number assigned to this iteration.

iteration_id string

ULID of the iteration.

fingerprint string

Successful Response

iteration object

The requested iteration.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the iteration.

bucket_slug string

Human-readable name for the bucket that this iteration is associated with.

iteration_ancestor_id string

The unique identifier of the iteration that was used as a source for this iteration, if this iteration was built on a base layer. Deprecated: refer to build specific source_build_ulid.

incremental_version integer

The human-readable version number assigned to this iteration. This field will only be set if the iteration is "complete".

complete boolean

author_id string

The name of the person who created this iteration.

created_at string

When the iteration was created.

updated_at string

When the iteration was last updated.

fingerprint string

Fingerprint of the iteration. The fingerprint is set by Packer when you call packer build.

builds object[]

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the build.

iteration_id string

Unique identifier of the iteration associated with this build; this was created and set by the HCP Packer registry when the iteration was created.

component_type string

Internal Packer name for the builder or post-processor component used to build this. For example, "amazon-ebs" or "azure-arm".

packer_run_uuid string

The UUID specific to this call to Packer build. If you use the manifest post-processor, this UUID will match the UUID present there.

images object[]

Represents the actual region:image_id mapping for a single image, in a single build.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) for the image.

image_id string

ID or URL of the remote cloud image as given by a build. For example, ami-12345.

region string

Cloud-specific region as provided by packer build. For example, "ap-east-1".

created_at string

Timestamp at which this image was created.

cloud_provider string

The cloud provider that this build produced artifacts for. For example, AWS, GCP, or Azure.

status string

Status of the build. The status can be RUNNING, DONE, CANCELLED, FAILED, or UNSET.

created_at string

When the build was created.

updated_at string

When the build was most recently updated.

source_image_id string

The ID or URL of the remote cloud source image that HCP Packer uses to track image dependencies for build pipelines.

labels object

A key:value map for custom, user-settable metadata about your build.

source_build_ulid string

Unique identifier of the HCP Packer registry build that Packer uses as the source for this build. HCP Packer uses this to track dependencies for build pipelines.

revoke_at string

Timestamp from when the iteration is revoked an no longer trusted to be secure.

revocation_message string

A short explanation of why this iteration was revoked.

revocation_author string

revocation_type string

Revocation type is 'manual' when the iteration is revoked directly or 'inherited' when the iteration inherits a revocation from an upstream ancestor.

revocation_inherited_from object

The ancestor iteration from whom this iteration inherited the revocation.

href string

The URL to get the revoked ancestor.

bucket_slug string

The revoked ancestor bucket slug.

iteration_incremental_version integer

The revoked ancestor iteration incremental version.

iteration_id string

The revoked ancestor iteration ULID.

iteration_fingerprint string

The revoked ancestor iteration fingerprint.

has_descendants boolean

If true, this iteration has children iterations. Knowing if an iteration has descendants can help taking decisions such as persist revocation to all its descendants or not.

template_type string

TEMPLATE_TYPE_UNSET: TEMPLATE_TYPE_UNSET is a sentinel zero value so that an uninitialized value can be detected.
HCL2: HCL2 configuration template; either pkr.hcl or pkr.json
JSON: Legacy JSON configuration template

The type of Packer configuration template used to build this iteration.

List IterationsGET/images/{bucket_slug}/iterations

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/iterations

Lists every existing iteration of a bucket.

Path Parameters

location.organization_id string

organization_id is the id of the organization.

location.project_id string

project_id is the projects id.

bucket_slug string

Human-readable name for the bucket.

Query Parameters

location.region.provider string

provider is the named cloud provider ("aws", "gcp", "azure")

location.region.region string

region is the cloud region ("us-west1", "us-east1")

pagination.page_size integer

pagination.next_page_token string

pagination.previous_page_token string

sorting.order_by string[]

Successful Response

iterations object[]

The list endpoint does not return build information.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the iteration.

bucket_slug string

Human-readable name for the bucket.

iteration_ancestor_id string

The unique identifier of the iteration that was used as a source for this iteration, if this iteration was built on a base layer. Deprecated: Deprecated: refer to build specific source_build_ulid.

incremental_version integer

The human-readable version number assigned to this iteration. This field will only be set if the iteration is "complete".

complete boolean

author_id string

Who created the iteration.

created_at string

When the iteration was created.

updated_at string

When the iteration was most recently updated.

fingerprint string

Fingerprint of the iteration. The fingerprint is set by Packer when you call packer build.

build_statuses object

Maps the build component type to its status enum, for displaying build status in the iterations view.

revoke_at string

Timestamp from when the iteration is revoked an no longer trusted to be secure.

revocation_message string

A short explanation of why this iteration was revoked.

revocation_author string

revocation_type string

Revocation type is 'manual' when self revoked or 'inherited' when inherited from a revoked ancestor.

revocation_inherited_from object

The ancestor iteration from whom this iteration inherited the revocation state.

href string

The URL to get the revoked ancestor.

bucket_slug string

The revoked ancestor bucket slug.

iteration_incremental_version integer

The revoked ancestor iteration incremental version.

iteration_id string

The revoked ancestor iteration ULID.

iteration_fingerprint string

The revoked ancestor iteration fingerprint.

has_descendants boolean

If true, this iteration has children iterations. Knowing if an iteration has descendants can help taking decisions such as persist revocation to all its descendants or not.

pagination object

PaginationResponse is the response holding the page tokens for a paginated list response.

next_page_token string

previous_page_token string

Create IterationPOST/images/{bucket_slug}/iterations

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/iterations

Creates an empty iteration to be written to. This API is called at the beginning of a new Packer build and does not create individual builds for the iteration.

Path Parameters

location.organization_id string

organization_id is the id of the organization.

location.project_id string

project_id is the projects id.

bucket_slug string

Human-readable name for the bucket.

Body Parameters

location object

Location represents a target for an operation in HCP.

region object

region is the region that the resource is located in. It is optional if the object being referenced is a global object.

provider string

provider is the named cloud provider ("aws", "gcp", "azure")

region string

region is the cloud region ("us-west1", "us-east1")

fingerprint string

template_type string

TEMPLATE_TYPE_UNSET: TEMPLATE_TYPE_UNSET is a sentinel zero value so that an uninitialized value can be detected.
HCL2: HCL2 configuration template; either pkr.hcl or pkr.json
JSON: Legacy JSON configuration template

The type of Packer configuration template used to build this iteration.

Successful Response

iteration object

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the iteration.

bucket_slug string

Human-readable name for the bucket that this iteration is associated with.

iteration_ancestor_id string

The unique identifier of the iteration that was used as a source for this iteration, if this iteration was built on a base layer. Deprecated: refer to build specific source_build_ulid.

incremental_version integer

The human-readable version number assigned to this iteration. This field will only be set if the iteration is "complete".

complete boolean

author_id string

The name of the person who created this iteration.

created_at string

When the iteration was created.

updated_at string

When the iteration was last updated.

fingerprint string

Fingerprint of the iteration. The fingerprint is set by Packer when you call packer build.

builds object[]

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the build.

iteration_id string

Unique identifier of the iteration associated with this build; this was created and set by the HCP Packer registry when the iteration was created.

component_type string

Internal Packer name for the builder or post-processor component used to build this. For example, "amazon-ebs" or "azure-arm".

packer_run_uuid string

The UUID specific to this call to Packer build. If you use the manifest post-processor, this UUID will match the UUID present there.

images object[]

Represents the actual region:image_id mapping for a single image, in a single build.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) for the image.

image_id string

ID or URL of the remote cloud image as given by a build. For example, ami-12345.

region string

Cloud-specific region as provided by packer build. For example, "ap-east-1".

created_at string

Timestamp at which this image was created.

cloud_provider string

The cloud provider that this build produced artifacts for. For example, AWS, GCP, or Azure.

status string

Status of the build. The status can be RUNNING, DONE, CANCELLED, FAILED, or UNSET.

created_at string

When the build was created.

updated_at string

When the build was most recently updated.

source_image_id string

The ID or URL of the remote cloud source image that HCP Packer uses to track image dependencies for build pipelines.

labels object

A key:value map for custom, user-settable metadata about your build.

source_build_ulid string

Unique identifier of the HCP Packer registry build that Packer uses as the source for this build. HCP Packer uses this to track dependencies for build pipelines.

revoke_at string

Timestamp from when the iteration is revoked an no longer trusted to be secure.

revocation_message string

A short explanation of why this iteration was revoked.

revocation_author string

revocation_type string

Revocation type is 'manual' when the iteration is revoked directly or 'inherited' when the iteration inherits a revocation from an upstream ancestor.

revocation_inherited_from object

The ancestor iteration from whom this iteration inherited the revocation.

href string

The URL to get the revoked ancestor.

bucket_slug string

The revoked ancestor bucket slug.

iteration_incremental_version integer

The revoked ancestor iteration incremental version.

iteration_id string

The revoked ancestor iteration ULID.

iteration_fingerprint string

The revoked ancestor iteration fingerprint.

has_descendants boolean

If true, this iteration has children iterations. Knowing if an iteration has descendants can help taking decisions such as persist revocation to all its descendants or not.

template_type string

TEMPLATE_TYPE_UNSET: TEMPLATE_TYPE_UNSET is a sentinel zero value so that an uninitialized value can be detected.
HCL2: HCL2 configuration template; either pkr.hcl or pkr.json
JSON: Legacy JSON configuration template

The type of Packer configuration template used to build this iteration.

Create BuildPOST/images/{bucket_slug}/iterations/{iteration_id}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/iterations/{iteration_id}

Creates an image build in the provided image iteration. It is called once for each "build source" in a Packer build run. The request will error if the build for a given cloud provider already exists.

Path Parameters

location.organization_id string

organization_id is the id of the organization.

location.project_id string

project_id is the projects id.

bucket_slug string

Human-readable name for the bucket.

iteration_id string

ULID of the iteration that this build should be associated with.

Body Parameters

location object

Location represents a target for an operation in HCP.

region object

region is the region that the resource is located in. It is optional if the object being referenced is a global object.

provider string

provider is the named cloud provider ("aws", "gcp", "azure")

region string

region is the cloud region ("us-west1", "us-east1")

build object

Information about the build to create.

component_type string

Internal Packer name for the builder or post-processor component used to build this. For example, "amazon-ebs" or "azure-arm"

packer_run_uuid string

The UUID specific to this call to Packer build. If you use the manifest post-processor, this UUID will match the UUID present there.

images object[]

This message is used for build/create calls; it removes elements from the Image message that the user cannot set.

image_id string

ID or URL of the remote cloud image as given by a build.

region string

Cloud-specific region as provided by packer build. For example, "ap-east-1".

cloud_provider string

The cloud provider that this build produced artifacts for. For example, AWS, GCP, or Azure.

status string

Status of the build. The status can be RUNNING, DONE, CANCELLED, FAILED, or UNSET.

source_image_id string

The ID or URL of the remote cloud source image. Used for tracking image dependencies for build pipelines.

source_iteration_id string

The ID of the parent iteration associated with the source_image_id. When the source iteration ID is set, the source image ID should also be set.

source_channel_id string

The ID of the channel that it was used to fetch the source_iteration_id. When the source channel ID is set, the source iteration ID should also be set.

labels object

A key:value map for custom, user-settable metadata about your build.

fingerprint string

Successful Response

build object

Information about the build that was created.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the build.

iteration_id string

Unique identifier of the iteration associated with this build; this was created and set by the HCP Packer registry when the iteration was created.

component_type string

Internal Packer name for the builder or post-processor component used to build this. For example, "amazon-ebs" or "azure-arm".

packer_run_uuid string

The UUID specific to this call to Packer build. If you use the manifest post-processor, this UUID will match the UUID present there.

images object[]

Represents the actual region:image_id mapping for a single image, in a single build.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) for the image.

image_id string

ID or URL of the remote cloud image as given by a build. For example, ami-12345.

region string

Cloud-specific region as provided by packer build. For example, "ap-east-1".

created_at string

Timestamp at which this image was created.

cloud_provider string

The cloud provider that this build produced artifacts for. For example, AWS, GCP, or Azure.

status string

Status of the build. The status can be RUNNING, DONE, CANCELLED, FAILED, or UNSET.

created_at string

When the build was created.

updated_at string

When the build was most recently updated.

source_image_id string

The ID or URL of the remote cloud source image that HCP Packer uses to track image dependencies for build pipelines.

labels object

A key:value map for custom, user-settable metadata about your build.

source_build_ulid string

Unique identifier of the HCP Packer registry build that Packer uses as the source for this build. HCP Packer uses this to track dependencies for build pipelines.

List BuildsGET/images/{bucket_slug}/iterations/{iteration_id}/builds

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/iterations/{iteration_id}/builds

Lists every existing build and its images for an iteration.

Path Parameters

location.organization_id string

organization_id is the id of the organization.

location.project_id string

project_id is the projects id.

bucket_slug string

Human-readable name for the bucket to list builds for.

iteration_id string

ULID of the iteration to list builds for.

Query Parameters

location.region.provider string

provider is the named cloud provider ("aws", "gcp", "azure")

location.region.region string

region is the cloud region ("us-west1", "us-east1")

pagination.page_size integer

pagination.next_page_token string

pagination.previous_page_token string

sorting.order_by string[]

Successful Response

location object

Location represents a target for an operation in HCP.

organization_id string

organization_id is the id of the organization.

project_id string

project_id is the projects id.

region object

region is the region that the resource is located in. It is optional if the object being referenced is a global object.

provider string

provider is the named cloud provider ("aws", "gcp", "azure")

region string

region is the cloud region ("us-west1", "us-east1")

pagination object

PaginationResponse is the response holding the page tokens for a paginated list response.

next_page_token string

previous_page_token string

builds object[]

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the build.

iteration_id string

Unique identifier of the iteration associated with this build; this was created and set by the HCP Packer registry when the iteration was created.

component_type string

Internal Packer name for the builder or post-processor component used to build this. For example, "amazon-ebs" or "azure-arm".

packer_run_uuid string

The UUID specific to this call to Packer build. If you use the manifest post-processor, this UUID will match the UUID present there.

images object[]

Represents the actual region:image_id mapping for a single image, in a single build.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) for the image.

image_id string

ID or URL of the remote cloud image as given by a build. For example, ami-12345.

region string

Cloud-specific region as provided by packer build. For example, "ap-east-1".

created_at string

Timestamp at which this image was created.

cloud_provider string

The cloud provider that this build produced artifacts for. For example, AWS, GCP, or Azure.

status string

Status of the build. The status can be RUNNING, DONE, CANCELLED, FAILED, or UNSET.

created_at string

When the build was created.

updated_at string

When the build was most recently updated.

source_image_id string

The ID or URL of the remote cloud source image that HCP Packer uses to track image dependencies for build pipelines.

labels object

A key:value map for custom, user-settable metadata about your build.

source_build_ulid string

Unique identifier of the HCP Packer registry build that Packer uses as the source for this build. HCP Packer uses this to track dependencies for build pipelines.

Delete IterationDELETE/iterations/{iteration_id}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/iterations/{iteration_id}

Deletes an iteration and all its information, such as its builds.

Path Parameters

location.organization_id string

organization_id is the id of the organization.

location.project_id string

project_id is the projects id.

iteration_id string

ULID of the iteration. This was created and set by the HCP Packer registry when the iteration was created.

Query Parameters

location.region.provider string

provider is the named cloud provider ("aws", "gcp", "azure")

location.region.region string

region is the cloud region ("us-west1", "us-east1")

bucket_slug string

Human-readable name for the bucket.

rollback_channels boolean

When set to true, any user created channels will be rolled back to the last valid iteration they were assigned to.

Update IterationPATCH/iterations/{iteration_id}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/iterations/{iteration_id}

This API can be used to revoke, restore, or complete an iteration. Revoking can be done at any time to complete or incomplete iterations, immediately or in the future depending on the passing timestamp. When an iteration is revoked, all its descendants will automatically get revoked unless 'skip_descendants_revocation' is set. Descendants will get revoked asynchronously to the request. Revoked iterations cannot be updated unless restored. To make build-specific updates for builds within the iteration, use the Update Build endpoint.

Path Parameters

location.organization_id string

organization_id is the id of the organization.

location.project_id string

project_id is the projects id.

iteration_id string

ULID of the iteration.

Body Parameters

location object

Location represents a target for an operation in HCP.

region object

region is the region that the resource is located in. It is optional if the object being referenced is a global object.

provider string

provider is the named cloud provider ("aws", "gcp", "azure")

region string

region is the cloud region ("us-west1", "us-east1")

bucket_slug string

Human-readable name for the bucket.

complete boolean

Set to "true" when all builds associated with this iteration have successfully completed and uploaded metadata to the registry. When "complete" is true, this iteration is considered ready to use, and can have channels assigned to it.

revocation_message string

Optional field to provide the reason for why this iteration is being revoked.

revoke_at string

revoke_at accepts strings in the RFC 3339 format to represent the revocation timestamp. To instantly revoke the iteration, provide the current timestamp. The revoke_at timestamp will always be recorded in UTC (Coordinated Universal Time). This option is equivalent to the 'revoke_in' option and therefore only one of them should be set when updating the iteration.

revoke_in string

revoke_in accepts a signed sequence of decimal numbers with a unit suffix to represent the duration to the revocation date, such as '30d' or '2h45m'. Valid time units are 's', 'm', 'h', and 'd' as for seconds, minutes, hours, and days. To instantly revoke the iteration, provide the duration of zero seconds ("0s"). The revoke_in duration will be used to calculate the iteration revocation timestamp, which will be recorded as UTC (Coordinated Universal Time). This option is equivalent to the 'revoke_at' option and therefore only one of them should be set when updating the iteration.

restore boolean

When set to true, will make a previously revoked iteration valid again.

skip_descendants_revocation boolean

When set to true, the iteration's descendants won't inherit its revocation status.

rollback_channels boolean

When set to true, any user created channels will be rolled back to the last valid iteration they were assigned to.

Successful Response

iteration object

Information about the updated iteration.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the iteration.

bucket_slug string

Human-readable name for the bucket that this iteration is associated with.

iteration_ancestor_id string

The unique identifier of the iteration that was used as a source for this iteration, if this iteration was built on a base layer. Deprecated: refer to build specific source_build_ulid.

incremental_version integer

The human-readable version number assigned to this iteration. This field will only be set if the iteration is "complete".

complete boolean

author_id string

The name of the person who created this iteration.

created_at string

When the iteration was created.

updated_at string

When the iteration was last updated.

fingerprint string

Fingerprint of the iteration. The fingerprint is set by Packer when you call packer build.

builds object[]

id string

Universally Unique Lexicographically Sortable Identifier (ULID) of the build.

iteration_id string

Unique identifier of the iteration associated with this build; this was created and set by the HCP Packer registry when the iteration was created.

component_type string

Internal Packer name for the builder or post-processor component used to build this. For example, "amazon-ebs" or "azure-arm".

packer_run_uuid string

The UUID specific to this call to Packer build. If you use the manifest post-processor, this UUID will match the UUID present there.

images object[]

Represents the actual region:image_id mapping for a single image, in a single build.

id string

Universally Unique Lexicographically Sortable Identifier (ULID) for the image.

image_id string

ID or URL of the remote cloud image as given by a build. For example, ami-12345.

region string

Cloud-specific region as provided by packer build. For example, "ap-east-1".

created_at string

Timestamp at which this image was created.

cloud_provider string

The cloud provider that this build produced artifacts for. For example, AWS, GCP, or Azure.

status string

Status of the build. The status can be RUNNING, DONE, CANCELLED, FAILED, or UNSET.

created_at string

When the build was created.

updated_at string

When the build was most recently updated.

source_image_id string

The ID or URL of the remote cloud source image that HCP Packer uses to track image dependencies for build pipelines.

labels object

A key:value map for custom, user-settable metadata about your build.

source_build_ulid string

Unique identifier of the HCP Packer registry build that Packer uses as the source for this build. HCP Packer uses this to track dependencies for build pipelines.

revoke_at string

Timestamp from when the iteration is revoked an no longer trusted to be secure.

revocation_message string

A short explanation of why this iteration was revoked.

revocation_author string

revocation_type string

Revocation type is 'manual' when the iteration is revoked directly or 'inherited' when the iteration inherits a revocation from an upstream ancestor.

revocation_inherited_from object

The ancestor iteration from whom this iteration inherited the revocation.

href string

The URL to get the revoked ancestor.

bucket_slug string

The revoked ancestor bucket slug.

iteration_incremental_version integer

The revoked ancestor iteration incremental version.

iteration_id string

The revoked ancestor iteration ULID.

iteration_fingerprint string

The revoked ancestor iteration fingerprint.

has_descendants boolean

If true, this iteration has children iterations. Knowing if an iteration has descendants can help taking decisions such as persist revocation to all its descendants or not.

template_type string

TEMPLATE_TYPE_UNSET: TEMPLATE_TYPE_UNSET is a sentinel zero value so that an uninitialized value can be detected.
HCL2: HCL2 configuration template; either pkr.hcl or pkr.json
JSON: Legacy JSON configuration template

The type of Packer configuration template used to build this iteration.

operation object

When revoking, use this operation to follow the asynchronous process of revoking all the iteration's descendants.

id string

id is the unique ID for this operation used in other RPC calls. This ID is only guaranteed to be unique within the region that the operation is running in.

state string

state is the current state of the operation. This is a simple tri-state: PENDING means the operation is created but not yet started, RUNNING means the operation is currently running (though it may be very long-running), and DONE means the operation is complete whether successfully or not.

error object

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details.

You can find out more about this error model and how to work with it in the API Design Guide.

code integer

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

message string

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

details object[]

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++.

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

Example 2: Pack and unpack a message in Java.

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

 foo := &pb.Foo{...}
 any, err := anypb.New(foo)
 if err != nil {
   ...
 }
 ...
 foo := &pb.Foo{}
 if err := any.UnmarshalTo(foo); err != nil {
   ...
 }

The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

JSON

The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example:

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]):

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

@type string

A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).

In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

If no scheme is provided, https is assumed.
An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

response object

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++.

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

Example 2: Pack and unpack a message in Java.

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

 foo := &pb.Foo{...}
 any, err := anypb.New(foo)
 if err != nil {
   ...
 }
 ...
 foo := &pb.Foo{}
 if err := any.UnmarshalTo(foo); err != nil {
   ...
 }

JSON

The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example:

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

@type string

If no scheme is provided, https is assumed.
An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

location object

Location represents a target for an operation in HCP.

organization_id string

organization_id is the id of the organization.

project_id string

project_id is the projects id.

region object

region is the region that the resource is located in. It is optional if the object being referenced is a global object.

provider string

provider is the named cloud provider ("aws", "gcp", "azure")

region string

region is the cloud region ("us-west1", "us-east1")

link object

Link is the resource link the operation is associated with.

type string

type is the unique type of the resource. Each service publishes a unique set of types. The type value is recommended to be formatted in "." such as "hashicorp.hvn". This is to prevent conflicts in the future, but any string value will work.

id string

id is the identifier for this resource.

uuid string

uuid is the unique UUID for this resource.

location object

Location represents a target for an operation in HCP.

organization_id string

organization_id is the id of the organization.

project_id string

project_id is the projects id.

region object

region is the region that the resource is located in. It is optional if the object being referenced is a global object.

provider string

provider is the named cloud provider ("aws", "gcp", "azure")

region string

region is the cloud region ("us-west1", "us-east1")

description string

description is a human-friendly description for this link. This is used primarily for informational purposes such as error messages.

created_at string

CreatedAt is the timestamp of when the operation was first created.

updated_at string

UpdatedAt is the timestamp of when the operation was last updated.

Get RegistryGET/registry

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/registry

Gets a HCP Packer registry.

Path Parameters

location.organization_id string

organization_id is the id of the organization.

location.project_id string

project_id is the projects id.

Query Parameters

location.region.provider string

provider is the named cloud provider ("aws", "gcp", "azure")

location.region.region string

region is the cloud region ("us-west1", "us-east1")

Successful Response

registry object

id string

ULID of the registry.

location object

Location represents a target for an operation in HCP.

organization_id string

organization_id is the id of the organization.

project_id string

project_id is the projects id.

region object

region is the region that the resource is located in. It is optional if the object being referenced is a global object.

provider string

provider is the named cloud provider ("aws", "gcp", "azure")

region string

region is the cloud region ("us-west1", "us-east1")

config object

The HCP Packer Registry configuration

feature_tier string

PRIVATE_BETA: Deprecated

The feature tier for the registry.

activated boolean

A registry is activated when the system correctly starts billing for it.

billing_deprovision object

The information about the billing deactivation.

at string

The time the registry was deactivated of billing.

reason string

Reason of why the registry was deactivated.

tfc_run_task_config object

Required configuration to run TFC run tasks for validation against this registry.

api_id string

Unique per registry API id for running HCP Packer run tasks.

hmac_key string

Encrypted HMAC key used by Terraform Cloud to sign the requests to the HCP Packer run task API.

created_at string

When the registry was created.

updated_at string

When the registry was last updated.

Create RegistryPUT/registry

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/registry

Creates a HCP Packer registry and starts billing for it.

Path Parameters

location.organization_id string

organization_id is the id of the organization.

location.project_id string

project_id is the projects id.

Body Parameters

location object

Location represents a target for an operation in HCP.

region object

region is the region that the resource is located in. It is optional if the object being referenced is a global object.

provider string

provider is the named cloud provider ("aws", "gcp", "azure")

region string

region is the cloud region ("us-west1", "us-east1")

feature_tier string

PRIVATE_BETA: Deprecated

Feature tier of the Registry.

Successful Response

registry object

id string

ULID of the registry.

location object

Location represents a target for an operation in HCP.

organization_id string

organization_id is the id of the organization.

project_id string

project_id is the projects id.

region object

region is the region that the resource is located in. It is optional if the object being referenced is a global object.

provider string

provider is the named cloud provider ("aws", "gcp", "azure")

region string

region is the cloud region ("us-west1", "us-east1")

config object

The HCP Packer Registry configuration

feature_tier string

PRIVATE_BETA: Deprecated

The feature tier for the registry.

activated boolean

A registry is activated when the system correctly starts billing for it.

billing_deprovision object

The information about the billing deactivation.

at string

The time the registry was deactivated of billing.

reason string

Reason of why the registry was deactivated.

tfc_run_task_config object

Required configuration to run TFC run tasks for validation against this registry.

api_id string

Unique per registry API id for running HCP Packer run tasks.

hmac_key string

Encrypted HMAC key used by Terraform Cloud to sign the requests to the HCP Packer run task API.

created_at string

When the registry was created.

updated_at string

When the registry was last updated.

operation object

Operation represents a single operation.

id string

id is the unique ID for this operation used in other RPC calls. This ID is only guaranteed to be unique within the region that the operation is running in.

state string

error object

You can find out more about this error model and how to work with it in the API Design Guide.

code integer

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

message string

details object[]

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++.

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

Example 2: Pack and unpack a message in Java.

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

 foo := &pb.Foo{...}
 any, err := anypb.New(foo)
 if err != nil {
   ...
 }
 ...
 foo := &pb.Foo{}
 if err := any.UnmarshalTo(foo); err != nil {
   ...
 }

JSON

The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example:

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

@type string

If no scheme is provided, https is assumed.
An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

response object

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++.

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

Example 2: Pack and unpack a message in Java.

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

 foo := &pb.Foo{...}
 any, err := anypb.New(foo)
 if err != nil {
   ...
 }
 ...
 foo := &pb.Foo{}
 if err := any.UnmarshalTo(foo); err != nil {
   ...
 }

JSON

The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example:

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

@type string

If no scheme is provided, https is assumed.
An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

location object

Location represents a target for an operation in HCP.

organization_id string

organization_id is the id of the organization.

project_id string

project_id is the projects id.

region object

region is the region that the resource is located in. It is optional if the object being referenced is a global object.

provider string

provider is the named cloud provider ("aws", "gcp", "azure")

region string

region is the cloud region ("us-west1", "us-east1")

link object

Link is the resource link the operation is associated with.

type string

id string

id is the identifier for this resource.

uuid string

uuid is the unique UUID for this resource.

location object

Location represents a target for an operation in HCP.

organization_id string

organization_id is the id of the organization.

project_id string

project_id is the projects id.

region object

region is the region that the resource is located in. It is optional if the object being referenced is a global object.

provider string

provider is the named cloud provider ("aws", "gcp", "azure")

region string

region is the cloud region ("us-west1", "us-east1")

description string

description is a human-friendly description for this link. This is used primarily for informational purposes such as error messages.

created_at string

CreatedAt is the timestamp of when the operation was first created.

updated_at string

UpdatedAt is the timestamp of when the operation was last updated.

Delete RegistryDELETE/registry

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/registry

Deactivates an active HCP packer registry. Deactivating a registry will stop any additional billing for the resource. Setting the hard_delete param to true will delete the registry and any associated resources from the database.

Path Parameters

location.organization_id string

organization_id is the id of the organization.

location.project_id string

project_id is the projects id.

Query Parameters

location.region.provider string

provider is the named cloud provider ("aws", "gcp", "azure")

location.region.region string

region is the cloud region ("us-west1", "us-east1")

hard_delete boolean

When set to true, the registry will be deleted from database and recovery will no longer be possible.

Successful Response

registry object

id string

ULID of the registry.

location object

Location represents a target for an operation in HCP.

organization_id string

organization_id is the id of the organization.

project_id string

project_id is the projects id.

region object

region is the region that the resource is located in. It is optional if the object being referenced is a global object.

provider string

provider is the named cloud provider ("aws", "gcp", "azure")

region string

region is the cloud region ("us-west1", "us-east1")

config object

The HCP Packer Registry configuration

feature_tier string

PRIVATE_BETA: Deprecated

The feature tier for the registry.

activated boolean

A registry is activated when the system correctly starts billing for it.

billing_deprovision object

The information about the billing deactivation.

at string

The time the registry was deactivated of billing.

reason string

Reason of why the registry was deactivated.

tfc_run_task_config object

Required configuration to run TFC run tasks for validation against this registry.

api_id string

Unique per registry API id for running HCP Packer run tasks.

hmac_key string

Encrypted HMAC key used by Terraform Cloud to sign the requests to the HCP Packer run task API.

created_at string

When the registry was created.

updated_at string

When the registry was last updated.

operation object

Operation represents a single operation.

id string

id is the unique ID for this operation used in other RPC calls. This ID is only guaranteed to be unique within the region that the operation is running in.

state string

error object

You can find out more about this error model and how to work with it in the API Design Guide.

code integer

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

message string

details object[]

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++.

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

Example 2: Pack and unpack a message in Java.

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

 foo := &pb.Foo{...}
 any, err := anypb.New(foo)
 if err != nil {
   ...
 }
 ...
 foo := &pb.Foo{}
 if err := any.UnmarshalTo(foo); err != nil {
   ...
 }

JSON

The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example:

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

@type string

If no scheme is provided, https is assumed.
An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

response object

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++.

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

Example 2: Pack and unpack a message in Java.

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

 foo := &pb.Foo{...}
 any, err := anypb.New(foo)
 if err != nil {
   ...
 }
 ...
 foo := &pb.Foo{}
 if err := any.UnmarshalTo(foo); err != nil {
   ...
 }

JSON

The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example:

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

@type string

If no scheme is provided, https is assumed.
An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

location object

Location represents a target for an operation in HCP.

organization_id string

organization_id is the id of the organization.

project_id string

project_id is the projects id.

region object

region is the region that the resource is located in. It is optional if the object being referenced is a global object.

provider string

provider is the named cloud provider ("aws", "gcp", "azure")

region string

region is the cloud region ("us-west1", "us-east1")

link object

Link is the resource link the operation is associated with.

type string

id string

id is the identifier for this resource.

uuid string

uuid is the unique UUID for this resource.

location object

Location represents a target for an operation in HCP.

organization_id string

organization_id is the id of the organization.

project_id string

project_id is the projects id.

region object

region is the region that the resource is located in. It is optional if the object being referenced is a global object.

provider string

provider is the named cloud provider ("aws", "gcp", "azure")

region string

region is the cloud region ("us-west1", "us-east1")

description string

description is a human-friendly description for this link. This is used primarily for informational purposes such as error messages.

created_at string

CreatedAt is the timestamp of when the operation was first created.

updated_at string

UpdatedAt is the timestamp of when the operation was last updated.

Update RegistryPATCH/registry

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/registry

Updates the feature tier of an HCP Packer registry.

Path Parameters

location.organization_id string

organization_id is the id of the organization.

location.project_id string

project_id is the projects id.

Body Parameters

location object

Location represents a target for an operation in HCP.

region object

region is the region that the resource is located in. It is optional if the object being referenced is a global object.

provider string

provider is the named cloud provider ("aws", "gcp", "azure")

region string

region is the cloud region ("us-west1", "us-east1")

feature_tier string

PRIVATE_BETA: Deprecated

Feature tier of the Registry. When trying to update a registry to the deprecated PRIVATE_BETA tier, HCP Packer will automatically update to STANDARD.

activate boolean

Activates a deactivated registry. A registry can only be activated if the organization billing account is valid (e.g. valid credits or payment method).

Successful Response

registry object

id string

ULID of the registry.

location object

Location represents a target for an operation in HCP.

organization_id string

organization_id is the id of the organization.

project_id string

project_id is the projects id.

region object

region is the region that the resource is located in. It is optional if the object being referenced is a global object.

provider string

provider is the named cloud provider ("aws", "gcp", "azure")

region string

region is the cloud region ("us-west1", "us-east1")

config object

The HCP Packer Registry configuration

feature_tier string

PRIVATE_BETA: Deprecated

The feature tier for the registry.

activated boolean

A registry is activated when the system correctly starts billing for it.

billing_deprovision object

The information about the billing deactivation.

at string

The time the registry was deactivated of billing.

reason string

Reason of why the registry was deactivated.

tfc_run_task_config object

Required configuration to run TFC run tasks for validation against this registry.

api_id string

Unique per registry API id for running HCP Packer run tasks.

hmac_key string

Encrypted HMAC key used by Terraform Cloud to sign the requests to the HCP Packer run task API.

created_at string

When the registry was created.

updated_at string

When the registry was last updated.

operation object

Operation represents a single operation.

id string

id is the unique ID for this operation used in other RPC calls. This ID is only guaranteed to be unique within the region that the operation is running in.

state string

error object

You can find out more about this error model and how to work with it in the API Design Guide.

code integer

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

message string

details object[]

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++.

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

Example 2: Pack and unpack a message in Java.

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

 foo := &pb.Foo{...}
 any, err := anypb.New(foo)
 if err != nil {
   ...
 }
 ...
 foo := &pb.Foo{}
 if err := any.UnmarshalTo(foo); err != nil {
   ...
 }

JSON

The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example:

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

@type string

If no scheme is provided, https is assumed.
An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

response object

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++.

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

Example 2: Pack and unpack a message in Java.

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

 foo := &pb.Foo{...}
 any, err := anypb.New(foo)
 if err != nil {
   ...
 }
 ...
 foo := &pb.Foo{}
 if err := any.UnmarshalTo(foo); err != nil {
   ...
 }

JSON

The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example:

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

@type string

If no scheme is provided, https is assumed.
An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

location object

Location represents a target for an operation in HCP.

organization_id string

organization_id is the id of the organization.

project_id string

project_id is the projects id.

region object

region is the region that the resource is located in. It is optional if the object being referenced is a global object.

provider string

provider is the named cloud provider ("aws", "gcp", "azure")

region string

region is the cloud region ("us-west1", "us-east1")

link object

Link is the resource link the operation is associated with.

type string

id string

id is the identifier for this resource.

uuid string

uuid is the unique UUID for this resource.

location object

Location represents a target for an operation in HCP.

organization_id string

organization_id is the id of the organization.

project_id string

project_id is the projects id.

region object

region is the region that the resource is located in. It is optional if the object being referenced is a global object.

provider string

provider is the named cloud provider ("aws", "gcp", "azure")

region string

region is the cloud region ("us-west1", "us-east1")

description string

description is a human-friendly description for this link. This is used primarily for informational purposes such as error messages.

created_at string

CreatedAt is the timestamp of when the operation was first created.

updated_at string

UpdatedAt is the timestamp of when the operation was last updated.

Regenerate Tfc Run Task Hmac KeyPATCH/runtasks/hmac

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/runtasks/hmac

Regenerates the HMAC key used to sign requests from Terraform Cloud to HCP Packer run tasks.

Path Parameters

location.organization_id string

organization_id is the id of the organization.

location.project_id string

project_id is the projects id.

Body Parameters

location object

Location represents a target for an operation in HCP.

region object

region is the region that the resource is located in. It is optional if the object being referenced is a global object.

provider string

provider is the named cloud provider ("aws", "gcp", "azure")

region string

region is the cloud region ("us-west1", "us-east1")

Get Registry Tfc Run Task ApiGET/runtasks/{task_type}

Note: Operation paths have been truncated for clarity. The full path to this operation is below:

/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/runtasks/{task_type}

Gets the HCP Packer registry API URL and HMAC key to integrate with Terraform Cloud as a Run Task.

Path Parameters

location.organization_id string

organization_id is the id of the organization.

location.project_id string

project_id is the projects id.

task_type string

The HCP Packer Terraform Cloud run task type. Currently, the only existing type is validation.

Query Parameters

location.region.provider string

provider is the named cloud provider ("aws", "gcp", "azure")

location.region.region string

region is the cloud region ("us-west1", "us-east1")