HashiCorp Cloud Platform Packer Artifact RegistryStable
Packer Service
Lists all existing buckets in the HCP Packer registry.
Path Parameters
location.organization_id
string
Requiredorganization_id is the id of the organization.
location.project_id
string
Requiredproject_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[]
Creates a bucket in the HCP Packer registry.
Path Parameters
location.organization_id
string
Requiredorganization_id is the id of the organization.
location.project_id
string
Requiredproject_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")
Body Parameters
name
string
Human-readable name for the bucket.
description
string
A short description of what this bucket's artifacts are for.
labels
object
A key:value map for custom, user-settable metadata about your bucket.
Retrieves an existing bucket.
Path Parameters
location.organization_id
string
Requiredorganization_id is the id of the organization.
location.project_id
string
Requiredproject_id is the projects id.
bucket_name
string
RequiredQuery 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")
Deletes the bucket and all its information, such as versions, builds and artifacts.
Path Parameters
location.organization_id
string
Requiredorganization_id is the id of the organization.
location.project_id
string
Requiredproject_id is the projects id.
bucket_name
string
RequiredQuery 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")
Updates the bucket's information.
Path Parameters
location.organization_id
string
Requiredorganization_id is the id of the organization.
location.project_id
string
Requiredproject_id is the projects id.
bucket_name
string
RequiredQuery 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")
Body Parameters
platforms
string[]
description
string
A short description of what this bucket's artifacts are for.
labels
object
A key:value map for custom, user-settable metadata about your bucket.
Lists the ancestry relationships for the bucket. This includes direct source bucket (parents) and downstream artifacts built directly from the bucket (children).
Path Parameters
location.organization_id
string
Requiredorganization_id is the id of the organization.
location.project_id
string
Requiredproject_id is the projects id.
bucket_name
string
RequiredQuery 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 artifacts for this artifact bucket. Type 'children' lists all of the child artifacts built directly from this artifact bucket. If unset, defaults to listing both parent and child relationships for the artifact bucket.
channel_name
string
An artifact channel in the artifact bucket associated with the request. This property filters the results to children whose parent version was assigned to this channel when the children were built. If not specified, the endpoint returns all children built from any version in this artifact bucket.
version_fingerprint
string
Fingerprint of a version that HCP Packer uses to list that version's parents. All parents are the parent artifacts Packer used to build this version. If not specified, the endpoint returns the parents of the artifact bucket's latest version.
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.
Lists all channels of a given bucket.
Path Parameters
location.organization_id
string
Requiredorganization_id is the id of the organization.
location.project_id
string
Requiredproject_id is the projects id.
bucket_name
string
RequiredQuery 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")
Creates a channel either empty or assigned to a version.
Path Parameters
location.organization_id
string
Requiredorganization_id is the id of the organization.
location.project_id
string
Requiredproject_id is the projects id.
bucket_name
string
RequiredQuery 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")
Body Parameters
name
string
Human-readable name for the channel.
version_fingerprint
string
Fingerprint of the version. The fingerprint is set by Packer when you
call packer build
.
restricted
boolean
Whether this channel's access is restricted to users with write permission in the HCP Packer registry.
Retrieves a channel with the version that it is currently assigned if any.
Path Parameters
location.organization_id
string
Requiredorganization_id is the id of the organization.
location.project_id
string
Requiredproject_id is the projects id.
bucket_name
string
Requiredchannel_name
string
RequiredQuery 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")
Deletes a channel.
Path Parameters
location.organization_id
string
Requiredorganization_id is the id of the organization.
location.project_id
string
Requiredproject_id is the projects id.
bucket_name
string
Requiredchannel_name
string
RequiredQuery 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")
Updates the channel assignment and/or restriction.
Path Parameters
location.organization_id
string
Requiredorganization_id is the id of the organization.
location.project_id
string
Requiredproject_id is the projects id.
bucket_name
string
Requiredchannel_name
string
RequiredQuery 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")
Body Parameters
version_fingerprint
string
Fingerprint of the version. The fingerprint is set by Packer when you
call packer build
.
restricted
boolean
Whether this channel's access is restricted to users with write permission in the HCP Packer registry.
update_mask
string
The required mask of fields to update. Fields name are converted lower-camel naming conventions.
Example of usage:
- "versionFingerprint,restricted" will update both assigned version and channel restriction.
- "versionFingerprint" will only update the assigned version.
- "restricted" will only update the channel restriction.
Lists a channel assignement history.
Path Parameters
location.organization_id
string
Requiredorganization_id is the id of the organization.
location.project_id
string
Requiredproject_id is the projects id.
bucket_name
string
Requiredchannel_name
string
RequiredQuery 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.
Lists every existing version of a bucket.
Path Parameters
location.organization_id
string
Requiredorganization_id is the id of the organization.
location.project_id
string
Requiredproject_id is the projects id.
bucket_name
string
RequiredQuery 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[]
Creates an empty version to be written to. This API is called at the beginning of a new Packer build and does not create individual builds for the version.
Path Parameters
location.organization_id
string
Requiredorganization_id is the id of the organization.
location.project_id
string
Requiredproject_id is the projects id.
bucket_name
string
RequiredQuery 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")
Body Parameters
fingerprint
string
Fingerprint of the version 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 version.
A valid fingerprint is 1-40 characters long, begins and ends with a letter or number,
and contains only ASCII letters, numbers, hyphens, dots, and underscores.
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 version.
Retrieves the version using the version fingerprint.
Path Parameters
location.organization_id
string
Requiredorganization_id is the id of the organization.
location.project_id
string
Requiredproject_id is the projects id.
bucket_name
string
Requiredfingerprint
string
RequiredQuery 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")
Deletes the version and all its information, such as its builds and artifacts.
Path Parameters
location.organization_id
string
Requiredorganization_id is the id of the organization.
location.project_id
string
Requiredproject_id is the projects id.
bucket_name
string
Requiredfingerprint
string
RequiredQuery 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")
rollback_channels
boolean
When set to true, any user-created channels will automatically rolleback to the last valid version they were assigned to.
This API can be used to revoke, restore, or complete a version. When a version is revoked, all its descendants will automatically get revoked unless 'skip_descendants_revocation' is set. Descendants will get revoked asynchronously to the request. Revoked versions cannot be updated unless restored.
Path Parameters
location.organization_id
string
Requiredorganization_id is the id of the organization.
location.project_id
string
Requiredproject_id is the projects id.
bucket_name
string
Requiredfingerprint
string
RequiredQuery 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")
Body Parameters
complete
boolean
Set to "true" when all builds associated with this version have successfully completed and uploaded metadata to the registry. When "complete" is true, this version is considered ready to use, and can have channels assigned to it.
revocation_message
string
Optional field to provide the reason for why this version is being revoked.
revoke_at
string
revoke_at accepts strings in the RFC 3339 format to represent the revocation timestamp. To instantly revoke the version, 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 version.
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 version, provide the duration of zero seconds ("0s"). The revoke_in duration will be used to calculate the version 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 version.
restore
boolean
When set to true, will make a previously revoked version valid again.
skip_descendants_revocation
boolean
When set to true, the version's descendants won't inherit its revocation status.
disable_rollback_channels
boolean
When set to true, any user created channels will not be rolled back to the last valid version they were assigned to.
Lists every existing build and its artifacts for a version.
Path Parameters
location.organization_id
string
Requiredorganization_id is the id of the organization.
location.project_id
string
Requiredproject_id is the projects id.
bucket_name
string
Requiredfingerprint
string
RequiredQuery 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[]
Creates a build in the provided version. It is called once for each "build source" in a Packer build run. The request will error if the build for a given platform already exists.
Path Parameters
location.organization_id
string
Requiredorganization_id is the id of the organization.
location.project_id
string
Requiredproject_id is the projects id.
bucket_name
string
Requiredfingerprint
string
RequiredQuery 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")
Body Parameters
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.
external_identifier
string
ID or URL of the remote cloud artifact as given by a build.
region
string
Cloud-specific region as provided by packer build
. For example, "ap-east-1".
platform
string
The platform 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_external_identifier
string
The ID or URL of the remote cloud source artifact. Used for tracking artifact dependencies for build pipelines.
parent_version_id
string
The ID of the parent version associated with the source_external_identifier
.
parent_channel_id
string
The ID of the channel that was used to fetch the parent_version_id. When the parent_channel_id is set, parent_version_id should also be set.
labels
object
A key:value map for custom, user-settable metadata about your build.
Retrieves a build with its list of artifacts.
Path Parameters
location.organization_id
string
Requiredorganization_id is the id of the organization.
location.project_id
string
Requiredproject_id is the projects id.
bucket_name
string
Requiredfingerprint
string
Requiredbuild_id
string
RequiredQuery 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")
Deletes a build in the provided version.
Path Parameters
location.organization_id
string
Requiredorganization_id is the id of the organization.
location.project_id
string
Requiredproject_id is the projects id.
bucket_name
string
Requiredfingerprint
string
Requiredbuild_id
string
RequiredQuery 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")
Updates the build. This may be most often used for modifying the status of a currently running build.
Path Parameters
location.organization_id
string
Requiredorganization_id is the id of the organization.
location.project_id
string
Requiredproject_id is the projects id.
bucket_name
string
Requiredfingerprint
string
Requiredbuild_id
string
RequiredQuery 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")
Body Parameters
status
string
Status of the build. The status can be RUNNING, DONE, CANCELLED, FAILED, or UNSET.
platform
string
The platform 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.
external_identifier
string
ID or URL of the remote cloud artifact 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_external_identifier
string
The ID or URL of the remote cloud source artifact. Used for tracking artifact dependencies for build pipelines.
parent_version_id
string
The ID of the parent version associated with the source_external_identifier
.
parent_channel_id
string
The ID of the channel that was used to fetch the parent_version_id. When the parent_channel_id is set, parent_version_id should also be set.
packer
object
Information about the packer version, plugins, and OS.
cicd
object
Information about the CICD pipeline.
vcs
object
Information about the version control system.
Retrieves the HCP Packer registry.
Path Parameters
location.organization_id
string
Requiredorganization_id is the id of the organization.
location.project_id
string
Requiredproject_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")
Creates the HCP Packer registry and starts billing for it.
Path Parameters
location.organization_id
string
Requiredorganization_id is the id of the organization.
location.project_id
string
Requiredproject_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")
Body Parameters
feature_tier
string
Deletes the HCP Packer registry and any associated resources from the database.
Path Parameters
location.organization_id
string
Requiredorganization_id is the id of the organization.
location.project_id
string
Requiredproject_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")
Updates the feature tier OR activates/deactivates the HCP Packer registry. Deactivating a registry will stop any additional billing for the resource.
Path Parameters
location.organization_id
string
Requiredorganization_id is the id of the organization.
location.project_id
string
Requiredproject_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")
Body Parameters
feature_tier
string
activated
boolean
update_mask
string
To enable Activated
field use update_mask
. Send ["config.activated",]
if you want to activate or deactivate the
registry. If given []
, we will ignore activated
entirely.
Regenerates the HMAC key used to sign requests from Terraform Cloud to HCP Packer run tasks.
Path Parameters
location.organization_id
string
Requiredorganization_id is the id of the organization.
location.project_id
string
Requiredproject_id is the projects id.
Body Parameters
provider
string
provider is the named cloud provider ("aws", "gcp", "azure")
region
string
region is the cloud region ("us-west1", "us-east1")
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
Requiredorganization_id is the id of the organization.
location.project_id
string
Requiredproject_id is the projects id.
task_type
string
RequiredThe 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")