Acquisition complete HashiCorp officially joins the IBM family. Learn more
HashiCorp Cloud Platform

You are viewing documentation for version 2021-04-30. View latest version.

HCP Packer Artifact Registry

Loading…
Status
(opens in new tab)
stable

API for managing Packer images.

Download Spec

Operations

​Get​Build

get

​/​builds​/​{build_id}

​Get​Build

https://api.cloud.hashicorp.com/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/builds/{build_id}

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

build_idstringRequired

ULID of the build that should be retrieved.

Query Parameters
location.region.providerstring

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

location.region.regionstring

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

Response

200 - OK
buildobject
  • idstring

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

  • iteration_idstring

    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_typestring

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

  • packer_run_uuidstring

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

  • imagesobject[]

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

    • idstring

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

    • image_idstring

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

    • regionstring

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

    • created_atstring

      Timestamp at which this image was created.

  • cloud_providerstring

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

  • statusstring
    • UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
    • RUNNING: Running means the packer build is currently running.
    • DONE: Done means the packer build has finished successfully.
    • CANCELLED: Cancelled means the packer build was cancelled by a user.
    • FAILED: Failed means the packer build failed and therefore image creation failed.
  • created_atstring

    When the build was created.

  • updated_atstring

    When the build was most recently updated.

  • source_image_idstring

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

  • labelsobject

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

  • source_build_ulidstring

    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.

Default Error Response
codeinteger

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

messagestring

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.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Delete​Build

delete

​/​builds​/​{build_id}

​Delete​Build

https://api.cloud.hashicorp.com/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/builds/{build_id}

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

build_idstringRequired

ULID of the build that should be deleted.

Query Parameters
location.region.providerstring

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

location.region.regionstring

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

Response

Default Error Response
codeinteger

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

messagestring

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.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Update​Build

patch

​/​builds​/​{build_id}

​Update​Build

https://api.cloud.hashicorp.com/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/builds/{build_id}

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

build_idstringRequired

ULID of the build that should be updated.

Body Parameters
locationobject

Location represents a target for an operation in HCP.

  • regionobject

    Region identifies a Cloud data-plane region.

    • providerstring
    • regionstring
updatesobject

BuildUpdates is used to group the elements of a Build that are allowed to be updated after the build has been created. It is part of the UpdateBuildRequest.

  • statusstring
    • UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
    • RUNNING: Running means the packer build is currently running.
    • DONE: Done means the packer build has finished successfully.
    • CANCELLED: Cancelled means the packer build was cancelled by a user.
    • FAILED: Failed means the packer build failed and therefore image creation failed.
  • cloud_providerstring

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

  • packer_run_uuidstring

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

  • imagesobject[]

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

    • image_idstring

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

    • regionstring

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

  • labelsobject

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

  • source_image_idstring

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

  • source_iteration_idstring

    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_idstring

    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.

Response

200 - OK
buildobject
  • idstring

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

  • iteration_idstring

    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_typestring

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

  • packer_run_uuidstring

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

  • imagesobject[]

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

    • idstring

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

    • image_idstring

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

    • regionstring

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

    • created_atstring

      Timestamp at which this image was created.

  • cloud_providerstring

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

  • statusstring
    • UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
    • RUNNING: Running means the packer build is currently running.
    • DONE: Done means the packer build has finished successfully.
    • CANCELLED: Cancelled means the packer build was cancelled by a user.
    • FAILED: Failed means the packer build failed and therefore image creation failed.
  • created_atstring

    When the build was created.

  • updated_atstring

    When the build was most recently updated.

  • source_image_idstring

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

  • labelsobject

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

  • source_build_ulidstring

    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.

Default Error Response
codeinteger

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

messagestring

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.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​List​Buckets

get

​/​images

​List​Buckets

https://api.cloud.hashicorp.com/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

Query Parameters
location.region.providerstring

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

location.region.regionstring

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

pagination.page_sizeinteger

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_tokenstring

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_tokenstring

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_bystring[]

Specifies the list of per field ordering that should be used for sorting. The order matters as rows are sorted in order by fields and when the field matches, the next field is used to tie break the ordering. The per field default ordering is ascending.

The fields should be immutabile, unique, and orderable. If the field is not unique, more than one sort fields should be passed.

Example: oder_by=name,age desc,created_at asc In that case, 'name' will get the default 'ascending' order.

Response

200 - OK
bucketsobject[]
  • idstring

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

  • slugstring

    Human-readable name for the bucket.

  • locationobject

    Location represents a target for an operation in HCP.

    • organization_idstring

      organization_id is the id of the organization.

    • project_idstring

      project_id is the projects id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
  • latest_iterationobject

    A simplified Iteration used in Bucket to represent a bucket's latest iteration. This iteration representation does not contain ancestry information to avoid repetition.

    • idstring

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

    • bucket_slugstring

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

    • iteration_ancestor_idstring

      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_versioninteger

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

    • completeboolean

      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_idstring

      The name of the person who created this iteration.

    • created_atstring

      When the iteration was created.

    • updated_atstring

      When the iteration was last updated.

    • fingerprintstring

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

    • buildsobject[]

      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.

      • idstring

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

      • iteration_idstring

        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_typestring

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

      • packer_run_uuidstring

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

      • imagesobject[]

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

        • idstring

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

        • image_idstring

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

        • regionstring

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

        • created_atstring

          Timestamp at which this image was created.

      • cloud_providerstring

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

      • statusstring
        • UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
        • RUNNING: Running means the packer build is currently running.
        • DONE: Done means the packer build has finished successfully.
        • CANCELLED: Cancelled means the packer build was cancelled by a user.
        • FAILED: Failed means the packer build failed and therefore image creation failed.
      • created_atstring

        When the build was created.

      • updated_atstring

        When the build was most recently updated.

      • source_image_idstring

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

      • labelsobject

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

      • source_build_ulidstring

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

    • revoke_atstring

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

    • revocation_messagestring

      A short explanation of why this iteration was revoked.

    • revocation_authorstring

      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_typestring
      • MANUAL: This iteration was revoked manually.
      • INHERITED: This iteration inherited a revocation from an upstream ancestor and was revoked automatically.
    • revocation_inherited_fromobject
      • hrefstring

        The URL to get the revoked ancestor.

      • bucket_slugstring

        The revoked ancestor bucket slug.

      • iteration_incremental_versioninteger

        The revoked ancestor iteration incremental version.

      • iteration_idstring

        The revoked ancestor iteration ULID.

      • iteration_fingerprintstring

        The revoked ancestor iteration fingerprint.

  • latest_versioninteger

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

  • created_atstring

    When the bucket was created.

  • updated_atstring

    When the bucket was last updated.

  • platformsstring[]
  • descriptionstring

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

  • labelsobject

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

  • iteration_countstring

    The total number of iterations in this bucket.

  • parentsobject
    • hrefstring

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

    • statusstring
      • UNDETERMINED: HCP Packer cannot determine whether the child image is out of date. This status occurs when the parent iteration was not assigned to an image channel when Packer built the image, the image channel no longer exists in the image bucket, or HCP Packer is not tracking the parent.
      • UP_TO_DATE: The child image is built from the iteration currently assigned to the image channel.
      • OUT_OF_DATE: The child image is built from a different iteration than the one currently assigned to the image channel.
  • childrenobject
    • hrefstring

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

    • statusstring
      • UNDETERMINED: HCP Packer cannot determine whether the child image is out of date. This status occurs when the parent iteration was not assigned to an image channel when Packer built the image, the image channel no longer exists in the image bucket, or HCP Packer is not tracking the parent.
      • UP_TO_DATE: The child image is built from the iteration currently assigned to the image channel.
      • OUT_OF_DATE: The child image is built from a different iteration than the one currently assigned to the image channel.
paginationobject

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

  • next_page_tokenstring

    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_tokenstring

    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.

Default Error Response
codeinteger

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

messagestring

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.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Create​Bucket

put

​/​images

​Create​Bucket

https://api.cloud.hashicorp.com/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

Body Parameters
bucket_slugstring

Human-readable name for the bucket.

descriptionstring

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

labelsobject

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

locationobject

Location represents a target for an operation in HCP.

  • regionobject

    Region identifies a Cloud data-plane region.

    • providerstring
    • regionstring

Response

200 - OK
bucketobject
  • idstring

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

  • slugstring

    Human-readable name for the bucket.

  • locationobject

    Location represents a target for an operation in HCP.

    • organization_idstring

      organization_id is the id of the organization.

    • project_idstring

      project_id is the projects id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
  • latest_iterationobject

    A simplified Iteration used in Bucket to represent a bucket's latest iteration. This iteration representation does not contain ancestry information to avoid repetition.

    • idstring

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

    • bucket_slugstring

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

    • iteration_ancestor_idstring

      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_versioninteger

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

    • completeboolean

      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_idstring

      The name of the person who created this iteration.

    • created_atstring

      When the iteration was created.

    • updated_atstring

      When the iteration was last updated.

    • fingerprintstring

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

    • buildsobject[]

      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.

      • idstring

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

      • iteration_idstring

        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_typestring

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

      • packer_run_uuidstring

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

      • imagesobject[]

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

        • idstring

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

        • image_idstring

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

        • regionstring

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

        • created_atstring

          Timestamp at which this image was created.

      • cloud_providerstring

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

      • statusstring
        • UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
        • RUNNING: Running means the packer build is currently running.
        • DONE: Done means the packer build has finished successfully.
        • CANCELLED: Cancelled means the packer build was cancelled by a user.
        • FAILED: Failed means the packer build failed and therefore image creation failed.
      • created_atstring

        When the build was created.

      • updated_atstring

        When the build was most recently updated.

      • source_image_idstring

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

      • labelsobject

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

      • source_build_ulidstring

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

    • revoke_atstring

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

    • revocation_messagestring

      A short explanation of why this iteration was revoked.

    • revocation_authorstring

      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_typestring
      • MANUAL: This iteration was revoked manually.
      • INHERITED: This iteration inherited a revocation from an upstream ancestor and was revoked automatically.
    • revocation_inherited_fromobject
      • hrefstring

        The URL to get the revoked ancestor.

      • bucket_slugstring

        The revoked ancestor bucket slug.

      • iteration_incremental_versioninteger

        The revoked ancestor iteration incremental version.

      • iteration_idstring

        The revoked ancestor iteration ULID.

      • iteration_fingerprintstring

        The revoked ancestor iteration fingerprint.

  • latest_versioninteger

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

  • created_atstring

    When the bucket was created.

  • updated_atstring

    When the bucket was last updated.

  • platformsstring[]
  • descriptionstring

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

  • labelsobject

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

  • iteration_countstring

    The total number of iterations in this bucket.

  • parentsobject
    • hrefstring

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

    • statusstring
      • UNDETERMINED: HCP Packer cannot determine whether the child image is out of date. This status occurs when the parent iteration was not assigned to an image channel when Packer built the image, the image channel no longer exists in the image bucket, or HCP Packer is not tracking the parent.
      • UP_TO_DATE: The child image is built from the iteration currently assigned to the image channel.
      • OUT_OF_DATE: The child image is built from a different iteration than the one currently assigned to the image channel.
  • childrenobject
    • hrefstring

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

    • statusstring
      • UNDETERMINED: HCP Packer cannot determine whether the child image is out of date. This status occurs when the parent iteration was not assigned to an image channel when Packer built the image, the image channel no longer exists in the image bucket, or HCP Packer is not tracking the parent.
      • UP_TO_DATE: The child image is built from the iteration currently assigned to the image channel.
      • OUT_OF_DATE: The child image is built from a different iteration than the one currently assigned to the image channel.
Default Error Response
codeinteger

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

messagestring

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.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Get​Bucket

get

​/​images​/​{bucket_slug}

​Get​Bucket

https://api.cloud.hashicorp.com/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

bucket_slugstringRequired

Human-readable name for the bucket.

Query Parameters
location.region.providerstring

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

location.region.regionstring

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

bucket_idstring

ULID of the bucket.

Response

200 - OK
bucketobject
  • idstring

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

  • slugstring

    Human-readable name for the bucket.

  • locationobject

    Location represents a target for an operation in HCP.

    • organization_idstring

      organization_id is the id of the organization.

    • project_idstring

      project_id is the projects id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
  • latest_iterationobject

    A simplified Iteration used in Bucket to represent a bucket's latest iteration. This iteration representation does not contain ancestry information to avoid repetition.

    • idstring

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

    • bucket_slugstring

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

    • iteration_ancestor_idstring

      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_versioninteger

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

    • completeboolean

      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_idstring

      The name of the person who created this iteration.

    • created_atstring

      When the iteration was created.

    • updated_atstring

      When the iteration was last updated.

    • fingerprintstring

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

    • buildsobject[]

      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.

      • idstring

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

      • iteration_idstring

        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_typestring

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

      • packer_run_uuidstring

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

      • imagesobject[]

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

        • idstring

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

        • image_idstring

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

        • regionstring

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

        • created_atstring

          Timestamp at which this image was created.

      • cloud_providerstring

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

      • statusstring
        • UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
        • RUNNING: Running means the packer build is currently running.
        • DONE: Done means the packer build has finished successfully.
        • CANCELLED: Cancelled means the packer build was cancelled by a user.
        • FAILED: Failed means the packer build failed and therefore image creation failed.
      • created_atstring

        When the build was created.

      • updated_atstring

        When the build was most recently updated.

      • source_image_idstring

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

      • labelsobject

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

      • source_build_ulidstring

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

    • revoke_atstring

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

    • revocation_messagestring

      A short explanation of why this iteration was revoked.

    • revocation_authorstring

      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_typestring
      • MANUAL: This iteration was revoked manually.
      • INHERITED: This iteration inherited a revocation from an upstream ancestor and was revoked automatically.
    • revocation_inherited_fromobject
      • hrefstring

        The URL to get the revoked ancestor.

      • bucket_slugstring

        The revoked ancestor bucket slug.

      • iteration_incremental_versioninteger

        The revoked ancestor iteration incremental version.

      • iteration_idstring

        The revoked ancestor iteration ULID.

      • iteration_fingerprintstring

        The revoked ancestor iteration fingerprint.

  • latest_versioninteger

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

  • created_atstring

    When the bucket was created.

  • updated_atstring

    When the bucket was last updated.

  • platformsstring[]
  • descriptionstring

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

  • labelsobject

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

  • iteration_countstring

    The total number of iterations in this bucket.

  • parentsobject
    • hrefstring

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

    • statusstring
      • UNDETERMINED: HCP Packer cannot determine whether the child image is out of date. This status occurs when the parent iteration was not assigned to an image channel when Packer built the image, the image channel no longer exists in the image bucket, or HCP Packer is not tracking the parent.
      • UP_TO_DATE: The child image is built from the iteration currently assigned to the image channel.
      • OUT_OF_DATE: The child image is built from a different iteration than the one currently assigned to the image channel.
  • childrenobject
    • hrefstring

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

    • statusstring
      • UNDETERMINED: HCP Packer cannot determine whether the child image is out of date. This status occurs when the parent iteration was not assigned to an image channel when Packer built the image, the image channel no longer exists in the image bucket, or HCP Packer is not tracking the parent.
      • UP_TO_DATE: The child image is built from the iteration currently assigned to the image channel.
      • OUT_OF_DATE: The child image is built from a different iteration than the one currently assigned to the image channel.
Default Error Response
codeinteger

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

messagestring

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.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Delete​Bucket

delete

​/​images​/​{bucket_slug}

​Delete​Bucket

https://api.cloud.hashicorp.com/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

bucket_slugstringRequired

Human-readable name for the bucket.

Query Parameters
location.region.providerstring

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

location.region.regionstring

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

Response

Default Error Response
codeinteger

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

messagestring

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.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Update​Bucket

patch

​/​images​/​{bucket_slug}

​Update​Bucket

https://api.cloud.hashicorp.com/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

bucket_slugstringRequired

Human-readable name for the bucket.

Body Parameters
locationobject

Location represents a target for an operation in HCP.

  • regionobject

    Region identifies a Cloud data-plane region.

    • providerstring
    • regionstring
platformsstring[]
descriptionstring

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

labelsobject

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

Response

200 - OK
bucketobject
  • idstring

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

  • slugstring

    Human-readable name for the bucket.

  • locationobject

    Location represents a target for an operation in HCP.

    • organization_idstring

      organization_id is the id of the organization.

    • project_idstring

      project_id is the projects id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
  • latest_iterationobject

    A simplified Iteration used in Bucket to represent a bucket's latest iteration. This iteration representation does not contain ancestry information to avoid repetition.

    • idstring

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

    • bucket_slugstring

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

    • iteration_ancestor_idstring

      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_versioninteger

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

    • completeboolean

      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_idstring

      The name of the person who created this iteration.

    • created_atstring

      When the iteration was created.

    • updated_atstring

      When the iteration was last updated.

    • fingerprintstring

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

    • buildsobject[]

      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.

      • idstring

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

      • iteration_idstring

        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_typestring

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

      • packer_run_uuidstring

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

      • imagesobject[]

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

        • idstring

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

        • image_idstring

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

        • regionstring

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

        • created_atstring

          Timestamp at which this image was created.

      • cloud_providerstring

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

      • statusstring
        • UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
        • RUNNING: Running means the packer build is currently running.
        • DONE: Done means the packer build has finished successfully.
        • CANCELLED: Cancelled means the packer build was cancelled by a user.
        • FAILED: Failed means the packer build failed and therefore image creation failed.
      • created_atstring

        When the build was created.

      • updated_atstring

        When the build was most recently updated.

      • source_image_idstring

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

      • labelsobject

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

      • source_build_ulidstring

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

    • revoke_atstring

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

    • revocation_messagestring

      A short explanation of why this iteration was revoked.

    • revocation_authorstring

      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_typestring
      • MANUAL: This iteration was revoked manually.
      • INHERITED: This iteration inherited a revocation from an upstream ancestor and was revoked automatically.
    • revocation_inherited_fromobject
      • hrefstring

        The URL to get the revoked ancestor.

      • bucket_slugstring

        The revoked ancestor bucket slug.

      • iteration_incremental_versioninteger

        The revoked ancestor iteration incremental version.

      • iteration_idstring

        The revoked ancestor iteration ULID.

      • iteration_fingerprintstring

        The revoked ancestor iteration fingerprint.

  • latest_versioninteger

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

  • created_atstring

    When the bucket was created.

  • updated_atstring

    When the bucket was last updated.

  • platformsstring[]
  • descriptionstring

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

  • labelsobject

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

  • iteration_countstring

    The total number of iterations in this bucket.

  • parentsobject
    • hrefstring

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

    • statusstring
      • UNDETERMINED: HCP Packer cannot determine whether the child image is out of date. This status occurs when the parent iteration was not assigned to an image channel when Packer built the image, the image channel no longer exists in the image bucket, or HCP Packer is not tracking the parent.
      • UP_TO_DATE: The child image is built from the iteration currently assigned to the image channel.
      • OUT_OF_DATE: The child image is built from a different iteration than the one currently assigned to the image channel.
  • childrenobject
    • hrefstring

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

    • statusstring
      • UNDETERMINED: HCP Packer cannot determine whether the child image is out of date. This status occurs when the parent iteration was not assigned to an image channel when Packer built the image, the image channel no longer exists in the image bucket, or HCP Packer is not tracking the parent.
      • UP_TO_DATE: The child image is built from the iteration currently assigned to the image channel.
      • OUT_OF_DATE: The child image is built from a different iteration than the one currently assigned to the image channel.
Default Error Response
codeinteger

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

messagestring

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.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​List​Bucket​Ancestry

get

​/​images​/​{bucket_slug}​/​ancestry

​List​Bucket​Ancestry

https://api.cloud.hashicorp.com/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/ancestry

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

bucket_slugstringRequired

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

Query Parameters
location.region.providerstring

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

location.region.regionstring

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

typestring

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.

channelstring

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_sizeinteger

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_tokenstring

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_tokenstring

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.

incremental_versioninteger

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_idstring

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.

fingerprintstring

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.

Response

200 - OK
relationsobject[]

The parent-child relationship between two image buckets.

  • statusstring
    • UNDETERMINED: HCP Packer cannot determine whether the child image is out of date. This status occurs when the parent iteration was not assigned to an image channel when Packer built the image, the image channel no longer exists in the image bucket, or HCP Packer is not tracking the parent.
    • UP_TO_DATE: The child image is built from the iteration currently assigned to the image channel.
    • OUT_OF_DATE: The child image is built from a different iteration than the one currently assigned to the image channel.
  • parentobject
    • bucket_slugstring

      The parent bucket slug.

    • iteration_idstring

      The parent iteration ULID.

    • iteration_incremental_versioninteger

      The parent iteration incremental version.

    • iteration_fingerprintstring

      The parent iteration fingerprint.

    • channelstring

      The image channel associated with this relationship.

    • channel_iterationobject
      • idstring

        The currently assigned iteration's ULID.

      • incremental_versioninteger

        The currently assigned iteration's incremental version.

      • fingerprintstring

        The currently assigned iteration's build fingerprint.

  • childobject
    • bucket_slugstring

      The child image bucket's slug.

    • iteration_idstring

      The child iteration's ULID.

    • iteration_incremental_versioninteger

      The child iteration's incremental version.

    • iteration_fingerprintstring

      The child iteration's build fingerprint.

total_countinteger

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

paginationobject

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

  • next_page_tokenstring

    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_tokenstring

    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.

Default Error Response
codeinteger

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

messagestring

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.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​List​Channels

get

​/​images​/​{bucket_slug}​/​channels

​List​Channels

https://api.cloud.hashicorp.com/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/channels

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

bucket_slugstringRequired

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

Query Parameters
location.region.providerstring

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

location.region.regionstring

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

Response

200 - OK
channelsobject[]
  • idstring

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

  • slugstring

    Human-readable name for the channel.

  • bucket_slugstring

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

  • author_idstring

    The user who last updated the channel.

  • created_atstring

    When the channel was created.

  • pointerobject

    A Channel Pointer is a special object that tracks channel history by storing both which iteration the channel points to and also when the channel was updated to point at said iteration. Deprecated: The iteration object is directly embed to Channel.

    • iterationobject
      • idstring

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

      • bucket_slugstring

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

      • iteration_ancestor_idstring

        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_versioninteger

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

      • completeboolean

        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_idstring

        The name of the person who created this iteration.

      • created_atstring

        When the iteration was created.

      • updated_atstring

        When the iteration was last updated.

      • fingerprintstring

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

      • buildsobject[]
        • idstring

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

        • iteration_idstring

          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_typestring

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

        • packer_run_uuidstring

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

        • imagesobject[]

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

          • idstring

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

          • image_idstring

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

          • regionstring

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

          • created_atstring

            Timestamp at which this image was created.

        • cloud_providerstring

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

        • statusstring
          • UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
          • RUNNING: Running means the packer build is currently running.
          • DONE: Done means the packer build has finished successfully.
          • CANCELLED: Cancelled means the packer build was cancelled by a user.
          • FAILED: Failed means the packer build failed and therefore image creation failed.
        • created_atstring

          When the build was created.

        • updated_atstring

          When the build was most recently updated.

        • source_image_idstring

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

        • labelsobject

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

        • source_build_ulidstring

          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_atstring

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

      • revocation_messagestring

        A short explanation of why this iteration was revoked.

      • revocation_authorstring

        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_typestring
        • MANUAL: This iteration was revoked manually.
        • INHERITED: This iteration inherited a revocation from an upstream ancestor and was revoked automatically.
      • revocation_inherited_fromobject
        • hrefstring

          The URL to get the revoked ancestor.

        • bucket_slugstring

          The revoked ancestor bucket slug.

        • iteration_incremental_versioninteger

          The revoked ancestor iteration incremental version.

        • iteration_idstring

          The revoked ancestor iteration ULID.

        • iteration_fingerprintstring

          The revoked ancestor iteration fingerprint.

      • has_descendantsboolean

        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_typestring
    • author_idstring

      The user who pointed the channel to the iteration.

    • created_atstring

      When the channel pointer was created.

  • updated_atstring

    When the channel was last updated.

  • iterationobject
    • idstring

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

    • bucket_slugstring

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

    • iteration_ancestor_idstring

      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_versioninteger

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

    • completeboolean

      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_idstring

      The name of the person who created this iteration.

    • created_atstring

      When the iteration was created.

    • updated_atstring

      When the iteration was last updated.

    • fingerprintstring

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

    • buildsobject[]
      • idstring

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

      • iteration_idstring

        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_typestring

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

      • packer_run_uuidstring

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

      • imagesobject[]

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

        • idstring

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

        • image_idstring

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

        • regionstring

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

        • created_atstring

          Timestamp at which this image was created.

      • cloud_providerstring

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

      • statusstring
        • UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
        • RUNNING: Running means the packer build is currently running.
        • DONE: Done means the packer build has finished successfully.
        • CANCELLED: Cancelled means the packer build was cancelled by a user.
        • FAILED: Failed means the packer build failed and therefore image creation failed.
      • created_atstring

        When the build was created.

      • updated_atstring

        When the build was most recently updated.

      • source_image_idstring

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

      • labelsobject

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

      • source_build_ulidstring

        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_atstring

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

    • revocation_messagestring

      A short explanation of why this iteration was revoked.

    • revocation_authorstring

      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_typestring
      • MANUAL: This iteration was revoked manually.
      • INHERITED: This iteration inherited a revocation from an upstream ancestor and was revoked automatically.
    • revocation_inherited_fromobject
      • hrefstring

        The URL to get the revoked ancestor.

      • bucket_slugstring

        The revoked ancestor bucket slug.

      • iteration_incremental_versioninteger

        The revoked ancestor iteration incremental version.

      • iteration_idstring

        The revoked ancestor iteration ULID.

      • iteration_fingerprintstring

        The revoked ancestor iteration fingerprint.

    • has_descendantsboolean

      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_typestring
  • managedboolean

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

  • restrictedboolean

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

Default Error Response
codeinteger

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

messagestring

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.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Create​Channel

post

​/​images​/​{bucket_slug}​/​channels

​Create​Channel

https://api.cloud.hashicorp.com/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/channels

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

bucket_slugstringRequired

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

Body Parameters
slugstring

Human-readable name for the channel.

incremental_versioninteger

The human-readable version number assigned to this iteration.

iteration_idstring

ULID of the iteration.

fingerprintstring

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.

locationobject

Location represents a target for an operation in HCP.

  • regionobject

    Region identifies a Cloud data-plane region.

    • providerstring
    • regionstring
restrictionstring
  • 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.

Response

200 - OK
channelobject
  • idstring

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

  • slugstring

    Human-readable name for the channel.

  • bucket_slugstring

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

  • author_idstring

    The user who last updated the channel.

  • created_atstring

    When the channel was created.

  • pointerobject

    A Channel Pointer is a special object that tracks channel history by storing both which iteration the channel points to and also when the channel was updated to point at said iteration. Deprecated: The iteration object is directly embed to Channel.

    • iterationobject
      • idstring

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

      • bucket_slugstring

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

      • iteration_ancestor_idstring

        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_versioninteger

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

      • completeboolean

        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_idstring

        The name of the person who created this iteration.

      • created_atstring

        When the iteration was created.

      • updated_atstring

        When the iteration was last updated.

      • fingerprintstring

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

      • buildsobject[]
        • idstring

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

        • iteration_idstring

          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_typestring

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

        • packer_run_uuidstring

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

        • imagesobject[]

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

          • idstring

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

          • image_idstring

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

          • regionstring

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

          • created_atstring

            Timestamp at which this image was created.

        • cloud_providerstring

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

        • statusstring
          • UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
          • RUNNING: Running means the packer build is currently running.
          • DONE: Done means the packer build has finished successfully.
          • CANCELLED: Cancelled means the packer build was cancelled by a user.
          • FAILED: Failed means the packer build failed and therefore image creation failed.
        • created_atstring

          When the build was created.

        • updated_atstring

          When the build was most recently updated.

        • source_image_idstring

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

        • labelsobject

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

        • source_build_ulidstring

          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_atstring

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

      • revocation_messagestring

        A short explanation of why this iteration was revoked.

      • revocation_authorstring

        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_typestring
        • MANUAL: This iteration was revoked manually.
        • INHERITED: This iteration inherited a revocation from an upstream ancestor and was revoked automatically.
      • revocation_inherited_fromobject
        • hrefstring

          The URL to get the revoked ancestor.

        • bucket_slugstring

          The revoked ancestor bucket slug.

        • iteration_incremental_versioninteger

          The revoked ancestor iteration incremental version.

        • iteration_idstring

          The revoked ancestor iteration ULID.

        • iteration_fingerprintstring

          The revoked ancestor iteration fingerprint.

      • has_descendantsboolean

        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_typestring
    • author_idstring

      The user who pointed the channel to the iteration.

    • created_atstring

      When the channel pointer was created.

  • updated_atstring

    When the channel was last updated.

  • iterationobject
    • idstring

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

    • bucket_slugstring

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

    • iteration_ancestor_idstring

      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_versioninteger

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

    • completeboolean

      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_idstring

      The name of the person who created this iteration.

    • created_atstring

      When the iteration was created.

    • updated_atstring

      When the iteration was last updated.

    • fingerprintstring

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

    • buildsobject[]
      • idstring

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

      • iteration_idstring

        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_typestring

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

      • packer_run_uuidstring

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

      • imagesobject[]

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

        • idstring

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

        • image_idstring

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

        • regionstring

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

        • created_atstring

          Timestamp at which this image was created.

      • cloud_providerstring

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

      • statusstring
        • UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
        • RUNNING: Running means the packer build is currently running.
        • DONE: Done means the packer build has finished successfully.
        • CANCELLED: Cancelled means the packer build was cancelled by a user.
        • FAILED: Failed means the packer build failed and therefore image creation failed.
      • created_atstring

        When the build was created.

      • updated_atstring

        When the build was most recently updated.

      • source_image_idstring

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

      • labelsobject

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

      • source_build_ulidstring

        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_atstring

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

    • revocation_messagestring

      A short explanation of why this iteration was revoked.

    • revocation_authorstring

      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_typestring
      • MANUAL: This iteration was revoked manually.
      • INHERITED: This iteration inherited a revocation from an upstream ancestor and was revoked automatically.
    • revocation_inherited_fromobject
      • hrefstring

        The URL to get the revoked ancestor.

      • bucket_slugstring

        The revoked ancestor bucket slug.

      • iteration_incremental_versioninteger

        The revoked ancestor iteration incremental version.

      • iteration_idstring

        The revoked ancestor iteration ULID.

      • iteration_fingerprintstring

        The revoked ancestor iteration fingerprint.

    • has_descendantsboolean

      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_typestring
  • managedboolean

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

  • restrictedboolean

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

Default Error Response
codeinteger

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

messagestring

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.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Get​Channel

get

​/​images​/​{bucket_slug}​/​channels​/​{slug}

​Get​Channel

https://api.cloud.hashicorp.com/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/channels/{slug}

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

bucket_slugstringRequired

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

slugstringRequired

Human-readable name for the channel.

Query Parameters
location.region.providerstring

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

location.region.regionstring

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

Response

200 - OK
channelobject
  • idstring

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

  • slugstring

    Human-readable name for the channel.

  • bucket_slugstring

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

  • author_idstring

    The user who last updated the channel.

  • created_atstring

    When the channel was created.

  • pointerobject

    A Channel Pointer is a special object that tracks channel history by storing both which iteration the channel points to and also when the channel was updated to point at said iteration. Deprecated: The iteration object is directly embed to Channel.

    • iterationobject
      • idstring

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

      • bucket_slugstring

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

      • iteration_ancestor_idstring

        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_versioninteger

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

      • completeboolean

        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_idstring

        The name of the person who created this iteration.

      • created_atstring

        When the iteration was created.

      • updated_atstring

        When the iteration was last updated.

      • fingerprintstring

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

      • buildsobject[]
        • idstring

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

        • iteration_idstring

          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_typestring

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

        • packer_run_uuidstring

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

        • imagesobject[]

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

          • idstring

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

          • image_idstring

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

          • regionstring

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

          • created_atstring

            Timestamp at which this image was created.

        • cloud_providerstring

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

        • statusstring
          • UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
          • RUNNING: Running means the packer build is currently running.
          • DONE: Done means the packer build has finished successfully.
          • CANCELLED: Cancelled means the packer build was cancelled by a user.
          • FAILED: Failed means the packer build failed and therefore image creation failed.
        • created_atstring

          When the build was created.

        • updated_atstring

          When the build was most recently updated.

        • source_image_idstring

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

        • labelsobject

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

        • source_build_ulidstring

          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_atstring

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

      • revocation_messagestring

        A short explanation of why this iteration was revoked.

      • revocation_authorstring

        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_typestring
        • MANUAL: This iteration was revoked manually.
        • INHERITED: This iteration inherited a revocation from an upstream ancestor and was revoked automatically.
      • revocation_inherited_fromobject
        • hrefstring

          The URL to get the revoked ancestor.

        • bucket_slugstring

          The revoked ancestor bucket slug.

        • iteration_incremental_versioninteger

          The revoked ancestor iteration incremental version.

        • iteration_idstring

          The revoked ancestor iteration ULID.

        • iteration_fingerprintstring

          The revoked ancestor iteration fingerprint.

      • has_descendantsboolean

        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_typestring
    • author_idstring

      The user who pointed the channel to the iteration.

    • created_atstring

      When the channel pointer was created.

  • updated_atstring

    When the channel was last updated.

  • iterationobject
    • idstring

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

    • bucket_slugstring

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

    • iteration_ancestor_idstring

      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_versioninteger

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

    • completeboolean

      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_idstring

      The name of the person who created this iteration.

    • created_atstring

      When the iteration was created.

    • updated_atstring

      When the iteration was last updated.

    • fingerprintstring

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

    • buildsobject[]
      • idstring

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

      • iteration_idstring

        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_typestring

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

      • packer_run_uuidstring

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

      • imagesobject[]

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

        • idstring

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

        • image_idstring

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

        • regionstring

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

        • created_atstring

          Timestamp at which this image was created.

      • cloud_providerstring

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

      • statusstring
        • UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
        • RUNNING: Running means the packer build is currently running.
        • DONE: Done means the packer build has finished successfully.
        • CANCELLED: Cancelled means the packer build was cancelled by a user.
        • FAILED: Failed means the packer build failed and therefore image creation failed.
      • created_atstring

        When the build was created.

      • updated_atstring

        When the build was most recently updated.

      • source_image_idstring

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

      • labelsobject

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

      • source_build_ulidstring

        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_atstring

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

    • revocation_messagestring

      A short explanation of why this iteration was revoked.

    • revocation_authorstring

      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_typestring
      • MANUAL: This iteration was revoked manually.
      • INHERITED: This iteration inherited a revocation from an upstream ancestor and was revoked automatically.
    • revocation_inherited_fromobject
      • hrefstring

        The URL to get the revoked ancestor.

      • bucket_slugstring

        The revoked ancestor bucket slug.

      • iteration_incremental_versioninteger

        The revoked ancestor iteration incremental version.

      • iteration_idstring

        The revoked ancestor iteration ULID.

      • iteration_fingerprintstring

        The revoked ancestor iteration fingerprint.

    • has_descendantsboolean

      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_typestring
  • managedboolean

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

  • restrictedboolean

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

Default Error Response
codeinteger

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

messagestring

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.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Delete​Channel

delete

​/​images​/​{bucket_slug}​/​channels​/​{slug}

​Delete​Channel

https://api.cloud.hashicorp.com/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/channels/{slug}

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

bucket_slugstringRequired

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

slugstringRequired

Human-readable name for the channel.

Query Parameters
location.region.providerstring

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

location.region.regionstring

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

Response

Default Error Response
codeinteger

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

messagestring

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.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Update​Channel

patch

​/​images​/​{bucket_slug}​/​channels​/​{slug}

​Update​Channel

https://api.cloud.hashicorp.com/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/channels/{slug}

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

bucket_slugstringRequired

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

slugstringRequired

Human-readable name for the channel.

Body Parameters
incremental_versioninteger

The human-readable version number assigned to this iteration.

iteration_idstring

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

fingerprintstring

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.

locationobject

Location represents a target for an operation in HCP.

  • regionobject

    Region identifies a Cloud data-plane region.

    • providerstring
    • regionstring
restrictionstring
  • 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.
maskstring

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"

Response

200 - OK
channelobject
  • idstring

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

  • slugstring

    Human-readable name for the channel.

  • bucket_slugstring

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

  • author_idstring

    The user who last updated the channel.

  • created_atstring

    When the channel was created.

  • pointerobject

    A Channel Pointer is a special object that tracks channel history by storing both which iteration the channel points to and also when the channel was updated to point at said iteration. Deprecated: The iteration object is directly embed to Channel.

    • iterationobject
      • idstring

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

      • bucket_slugstring

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

      • iteration_ancestor_idstring

        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_versioninteger

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

      • completeboolean

        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_idstring

        The name of the person who created this iteration.

      • created_atstring

        When the iteration was created.

      • updated_atstring

        When the iteration was last updated.

      • fingerprintstring

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

      • buildsobject[]
        • idstring

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

        • iteration_idstring

          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_typestring

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

        • packer_run_uuidstring

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

        • imagesobject[]

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

          • idstring

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

          • image_idstring

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

          • regionstring

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

          • created_atstring

            Timestamp at which this image was created.

        • cloud_providerstring

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

        • statusstring
          • UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
          • RUNNING: Running means the packer build is currently running.
          • DONE: Done means the packer build has finished successfully.
          • CANCELLED: Cancelled means the packer build was cancelled by a user.
          • FAILED: Failed means the packer build failed and therefore image creation failed.
        • created_atstring

          When the build was created.

        • updated_atstring

          When the build was most recently updated.

        • source_image_idstring

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

        • labelsobject

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

        • source_build_ulidstring

          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_atstring

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

      • revocation_messagestring

        A short explanation of why this iteration was revoked.

      • revocation_authorstring

        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_typestring
        • MANUAL: This iteration was revoked manually.
        • INHERITED: This iteration inherited a revocation from an upstream ancestor and was revoked automatically.
      • revocation_inherited_fromobject
        • hrefstring

          The URL to get the revoked ancestor.

        • bucket_slugstring

          The revoked ancestor bucket slug.

        • iteration_incremental_versioninteger

          The revoked ancestor iteration incremental version.

        • iteration_idstring

          The revoked ancestor iteration ULID.

        • iteration_fingerprintstring

          The revoked ancestor iteration fingerprint.

      • has_descendantsboolean

        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_typestring
    • author_idstring

      The user who pointed the channel to the iteration.

    • created_atstring

      When the channel pointer was created.

  • updated_atstring

    When the channel was last updated.

  • iterationobject
    • idstring

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

    • bucket_slugstring

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

    • iteration_ancestor_idstring

      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_versioninteger

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

    • completeboolean

      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_idstring

      The name of the person who created this iteration.

    • created_atstring

      When the iteration was created.

    • updated_atstring

      When the iteration was last updated.

    • fingerprintstring

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

    • buildsobject[]
      • idstring

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

      • iteration_idstring

        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_typestring

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

      • packer_run_uuidstring

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

      • imagesobject[]

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

        • idstring

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

        • image_idstring

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

        • regionstring

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

        • created_atstring

          Timestamp at which this image was created.

      • cloud_providerstring

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

      • statusstring
        • UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
        • RUNNING: Running means the packer build is currently running.
        • DONE: Done means the packer build has finished successfully.
        • CANCELLED: Cancelled means the packer build was cancelled by a user.
        • FAILED: Failed means the packer build failed and therefore image creation failed.
      • created_atstring

        When the build was created.

      • updated_atstring

        When the build was most recently updated.

      • source_image_idstring

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

      • labelsobject

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

      • source_build_ulidstring

        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_atstring

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

    • revocation_messagestring

      A short explanation of why this iteration was revoked.

    • revocation_authorstring

      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_typestring
      • MANUAL: This iteration was revoked manually.
      • INHERITED: This iteration inherited a revocation from an upstream ancestor and was revoked automatically.
    • revocation_inherited_fromobject
      • hrefstring

        The URL to get the revoked ancestor.

      • bucket_slugstring

        The revoked ancestor bucket slug.

      • iteration_incremental_versioninteger

        The revoked ancestor iteration incremental version.

      • iteration_idstring

        The revoked ancestor iteration ULID.

      • iteration_fingerprintstring

        The revoked ancestor iteration fingerprint.

    • has_descendantsboolean

      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_typestring
  • managedboolean

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

  • restrictedboolean

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

Default Error Response
codeinteger

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

messagestring

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.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​List​Channel​History

get

​/​images​/​{bucket_slug}​/​channels​/​{slug}​/​history

​List​Channel​History

https://api.cloud.hashicorp.com/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/channels/{slug}/history

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

bucket_slugstringRequired

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

slugstringRequired

Human-readable name for the channel.

Query Parameters
location.region.providerstring

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

location.region.regionstring

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

pagination.page_sizeinteger

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_tokenstring

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_tokenstring

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.

Response

200 - OK
historyobject[]

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

  • iterationobject
    • idstring

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

    • incremental_versioninteger

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

    • fingerprintstring

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

    • statusstring
      • ITERATION_UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
      • ITERATION_RUNNING: Running means the packer build is currently running in the iteration.
      • ITERATION_CANCELLED: Cancelled means the packer build was cancelled by a user.
      • ITERATION_FAILED: Failed means the packer build failed and therefore image creation failed.
      • ITERATION_REVOKED: Revoked means the iteration has been revoked.
      • ITERATION_REVOCATION_SCHEDULED: Revocation scheduled means the iteration has been scheduled to be revoked.
      • ITERATION_ACTIVE: Active means the iteration is valid and ready to be used.
    • parentsobject
      • hrefstring

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

      • statusstring
        • UNDETERMINED: HCP Packer cannot determine whether the child image is out of date. This status occurs when the parent iteration was not assigned to an image channel when Packer built the image, the image channel no longer exists in the image bucket, or HCP Packer is not tracking the parent.
        • UP_TO_DATE: The child image is built from the iteration currently assigned to the image channel.
        • OUT_OF_DATE: The child image is built from a different iteration than the one currently assigned to the image channel.
  • author_idstring

    The user who assigned this iteration.

  • promoted_atstring

    When the iteration assigment happened.

countinteger
paginationobject

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

  • next_page_tokenstring

    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_tokenstring

    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.

Default Error Response
codeinteger

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

messagestring

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.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Get​Iteration

get

​/​images​/​{bucket_slug}​/​iteration

​Get​Iteration

https://api.cloud.hashicorp.com/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/iteration

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

bucket_slugstringRequired

Human-readable name for the bucket.

Query Parameters
location.region.providerstring

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

location.region.regionstring

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

incremental_versioninteger

The human-readable version number assigned to this iteration.

iteration_idstring

ULID of the iteration.

fingerprintstring

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.

Response

200 - OK
iterationobject
  • idstring

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

  • bucket_slugstring

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

  • iteration_ancestor_idstring

    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_versioninteger

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

  • completeboolean

    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_idstring

    The name of the person who created this iteration.

  • created_atstring

    When the iteration was created.

  • updated_atstring

    When the iteration was last updated.

  • fingerprintstring

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

  • buildsobject[]
    • idstring

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

    • iteration_idstring

      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_typestring

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

    • packer_run_uuidstring

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

    • imagesobject[]

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

      • idstring

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

      • image_idstring

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

      • regionstring

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

      • created_atstring

        Timestamp at which this image was created.

    • cloud_providerstring

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

    • statusstring
      • UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
      • RUNNING: Running means the packer build is currently running.
      • DONE: Done means the packer build has finished successfully.
      • CANCELLED: Cancelled means the packer build was cancelled by a user.
      • FAILED: Failed means the packer build failed and therefore image creation failed.
    • created_atstring

      When the build was created.

    • updated_atstring

      When the build was most recently updated.

    • source_image_idstring

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

    • labelsobject

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

    • source_build_ulidstring

      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_atstring

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

  • revocation_messagestring

    A short explanation of why this iteration was revoked.

  • revocation_authorstring

    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_typestring
    • MANUAL: This iteration was revoked manually.
    • INHERITED: This iteration inherited a revocation from an upstream ancestor and was revoked automatically.
  • revocation_inherited_fromobject
    • hrefstring

      The URL to get the revoked ancestor.

    • bucket_slugstring

      The revoked ancestor bucket slug.

    • iteration_incremental_versioninteger

      The revoked ancestor iteration incremental version.

    • iteration_idstring

      The revoked ancestor iteration ULID.

    • iteration_fingerprintstring

      The revoked ancestor iteration fingerprint.

  • has_descendantsboolean

    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_typestring
Default Error Response
codeinteger

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

messagestring

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.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​List​Iterations

get

​/​images​/​{bucket_slug}​/​iterations

​List​Iterations

https://api.cloud.hashicorp.com/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/iterations

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

bucket_slugstringRequired

Human-readable name for the bucket.

Query Parameters
location.region.providerstring

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

location.region.regionstring

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

pagination.page_sizeinteger

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_tokenstring

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_tokenstring

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_bystring[]

Specifies the list of per field ordering that should be used for sorting. The order matters as rows are sorted in order by fields and when the field matches, the next field is used to tie break the ordering. The per field default ordering is ascending.

The fields should be immutabile, unique, and orderable. If the field is not unique, more than one sort fields should be passed.

Example: oder_by=name,age desc,created_at asc In that case, 'name' will get the default 'ascending' order.

Response

200 - OK
iterationsobject[]

The list endpoint does not return build information.

  • idstring

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

  • bucket_slugstring

    Human-readable name for the bucket.

  • iteration_ancestor_idstring

    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_versioninteger

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

  • completeboolean

    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_idstring

    Who created the iteration.

  • created_atstring

    When the iteration was created.

  • updated_atstring

    When the iteration was most recently updated.

  • fingerprintstring

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

  • build_statusesobject

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

  • revoke_atstring

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

  • revocation_messagestring

    A short explanation of why this iteration was revoked.

  • revocation_authorstring

    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_typestring
    • MANUAL: This iteration was revoked manually.
    • INHERITED: This iteration inherited a revocation from an upstream ancestor and was revoked automatically.
  • revocation_inherited_fromobject
    • hrefstring

      The URL to get the revoked ancestor.

    • bucket_slugstring

      The revoked ancestor bucket slug.

    • iteration_incremental_versioninteger

      The revoked ancestor iteration incremental version.

    • iteration_idstring

      The revoked ancestor iteration ULID.

    • iteration_fingerprintstring

      The revoked ancestor iteration fingerprint.

  • has_descendantsboolean

    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.

paginationobject

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

  • next_page_tokenstring

    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_tokenstring

    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.

Default Error Response
codeinteger

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

messagestring

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.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Create​Iteration

post

​/​images​/​{bucket_slug}​/​iterations

​Create​Iteration

https://api.cloud.hashicorp.com/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/iterations

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

bucket_slugstringRequired

Human-readable name for the bucket.

Body Parameters
locationobject

Location represents a target for an operation in HCP.

  • regionobject

    Region identifies a Cloud data-plane region.

    • providerstring
    • regionstring
fingerprintstring

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. A valid fingerprint is 1-40 characters long and contains only ASCII letters, numbers, hyphens, dots, quotes, and underscores.

template_typestring

Response

200 - OK
iterationobject
  • idstring

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

  • bucket_slugstring

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

  • iteration_ancestor_idstring

    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_versioninteger

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

  • completeboolean

    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_idstring

    The name of the person who created this iteration.

  • created_atstring

    When the iteration was created.

  • updated_atstring

    When the iteration was last updated.

  • fingerprintstring

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

  • buildsobject[]
    • idstring

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

    • iteration_idstring

      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_typestring

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

    • packer_run_uuidstring

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

    • imagesobject[]

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

      • idstring

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

      • image_idstring

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

      • regionstring

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

      • created_atstring

        Timestamp at which this image was created.

    • cloud_providerstring

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

    • statusstring
      • UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
      • RUNNING: Running means the packer build is currently running.
      • DONE: Done means the packer build has finished successfully.
      • CANCELLED: Cancelled means the packer build was cancelled by a user.
      • FAILED: Failed means the packer build failed and therefore image creation failed.
    • created_atstring

      When the build was created.

    • updated_atstring

      When the build was most recently updated.

    • source_image_idstring

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

    • labelsobject

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

    • source_build_ulidstring

      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_atstring

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

  • revocation_messagestring

    A short explanation of why this iteration was revoked.

  • revocation_authorstring

    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_typestring
    • MANUAL: This iteration was revoked manually.
    • INHERITED: This iteration inherited a revocation from an upstream ancestor and was revoked automatically.
  • revocation_inherited_fromobject
    • hrefstring

      The URL to get the revoked ancestor.

    • bucket_slugstring

      The revoked ancestor bucket slug.

    • iteration_incremental_versioninteger

      The revoked ancestor iteration incremental version.

    • iteration_idstring

      The revoked ancestor iteration ULID.

    • iteration_fingerprintstring

      The revoked ancestor iteration fingerprint.

  • has_descendantsboolean

    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_typestring
Default Error Response
codeinteger

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

messagestring

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.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Create​Build

post

​/​images​/​{bucket_slug}​/​iterations​/​{iteration_id}

​Create​Build

https://api.cloud.hashicorp.com/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/iterations/{iteration_id}

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

bucket_slugstringRequired

Human-readable name for the bucket.

iteration_idstringRequired

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

Body Parameters
locationobject

Location represents a target for an operation in HCP.

  • regionobject

    Region identifies a Cloud data-plane region.

    • providerstring
    • regionstring
buildobject

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

  • component_typestring
  • packer_run_uuidstring

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

  • imagesobject[]

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

    • image_idstring

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

    • regionstring

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

  • cloud_providerstring

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

  • statusstring
    • UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
    • RUNNING: Running means the packer build is currently running.
    • DONE: Done means the packer build has finished successfully.
    • CANCELLED: Cancelled means the packer build was cancelled by a user.
    • FAILED: Failed means the packer build failed and therefore image creation failed.
  • source_image_idstring

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

  • source_iteration_idstring

    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_idstring

    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.

  • labelsobject

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

fingerprintstring

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.

Response

200 - OK
buildobject
  • idstring

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

  • iteration_idstring

    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_typestring

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

  • packer_run_uuidstring

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

  • imagesobject[]

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

    • idstring

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

    • image_idstring

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

    • regionstring

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

    • created_atstring

      Timestamp at which this image was created.

  • cloud_providerstring

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

  • statusstring
    • UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
    • RUNNING: Running means the packer build is currently running.
    • DONE: Done means the packer build has finished successfully.
    • CANCELLED: Cancelled means the packer build was cancelled by a user.
    • FAILED: Failed means the packer build failed and therefore image creation failed.
  • created_atstring

    When the build was created.

  • updated_atstring

    When the build was most recently updated.

  • source_image_idstring

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

  • labelsobject

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

  • source_build_ulidstring

    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.

Default Error Response
codeinteger

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

messagestring

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.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​List​Builds

get

​/​images​/​{bucket_slug}​/​iterations​/​{iteration_id}​/​builds

​List​Builds

https://api.cloud.hashicorp.com/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/images/{bucket_slug}/iterations/{iteration_id}/builds

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

bucket_slugstringRequired

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

iteration_idstringRequired

ULID of the iteration to list builds for.

Query Parameters
location.region.providerstring

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

location.region.regionstring

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

pagination.page_sizeinteger

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_tokenstring

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_tokenstring

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_bystring[]

Specifies the list of per field ordering that should be used for sorting. The order matters as rows are sorted in order by fields and when the field matches, the next field is used to tie break the ordering. The per field default ordering is ascending.

The fields should be immutabile, unique, and orderable. If the field is not unique, more than one sort fields should be passed.

Example: oder_by=name,age desc,created_at asc In that case, 'name' will get the default 'ascending' order.

Response

200 - OK
locationobject

Location represents a target for an operation in HCP.

  • organization_idstring

    organization_id is the id of the organization.

  • project_idstring

    project_id is the projects id.

  • regionobject

    Region identifies a Cloud data-plane region.

    • providerstring
    • regionstring
paginationobject

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

  • next_page_tokenstring

    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_tokenstring

    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.

buildsobject[]
  • idstring

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

  • iteration_idstring

    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_typestring

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

  • packer_run_uuidstring

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

  • imagesobject[]

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

    • idstring

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

    • image_idstring

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

    • regionstring

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

    • created_atstring

      Timestamp at which this image was created.

  • cloud_providerstring

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

  • statusstring
    • UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
    • RUNNING: Running means the packer build is currently running.
    • DONE: Done means the packer build has finished successfully.
    • CANCELLED: Cancelled means the packer build was cancelled by a user.
    • FAILED: Failed means the packer build failed and therefore image creation failed.
  • created_atstring

    When the build was created.

  • updated_atstring

    When the build was most recently updated.

  • source_image_idstring

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

  • labelsobject

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

  • source_build_ulidstring

    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.

Default Error Response
codeinteger

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

messagestring

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.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Delete​Iteration

delete

​/​iterations​/​{iteration_id}

​Delete​Iteration

https://api.cloud.hashicorp.com/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/iterations/{iteration_id}

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

iteration_idstringRequired

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

Query Parameters
location.region.providerstring

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

location.region.regionstring

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

bucket_slugstring

Human-readable name for the bucket.

rollback_channelsboolean

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

Response

Default Error Response
codeinteger

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

messagestring

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.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Update​Iteration

patch

​/​iterations​/​{iteration_id}

​Update​Iteration

https://api.cloud.hashicorp.com/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/iterations/{iteration_id}

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

iteration_idstringRequired

ULID of the iteration.

Body Parameters
locationobject

Location represents a target for an operation in HCP.

  • regionobject

    Region identifies a Cloud data-plane region.

    • providerstring
    • regionstring
bucket_slugstring

Human-readable name for the bucket.

completeboolean

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_messagestring

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

revoke_atstring

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_instring

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.

restoreboolean

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

skip_descendants_revocationboolean

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

rollback_channelsboolean

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

Response

200 - OK
iterationobject
  • idstring

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

  • bucket_slugstring

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

  • iteration_ancestor_idstring

    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_versioninteger

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

  • completeboolean

    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_idstring

    The name of the person who created this iteration.

  • created_atstring

    When the iteration was created.

  • updated_atstring

    When the iteration was last updated.

  • fingerprintstring

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

  • buildsobject[]
    • idstring

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

    • iteration_idstring

      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_typestring

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

    • packer_run_uuidstring

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

    • imagesobject[]

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

      • idstring

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

      • image_idstring

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

      • regionstring

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

      • created_atstring

        Timestamp at which this image was created.

    • cloud_providerstring

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

    • statusstring
      • UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
      • RUNNING: Running means the packer build is currently running.
      • DONE: Done means the packer build has finished successfully.
      • CANCELLED: Cancelled means the packer build was cancelled by a user.
      • FAILED: Failed means the packer build failed and therefore image creation failed.
    • created_atstring

      When the build was created.

    • updated_atstring

      When the build was most recently updated.

    • source_image_idstring

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

    • labelsobject

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

    • source_build_ulidstring

      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_atstring

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

  • revocation_messagestring

    A short explanation of why this iteration was revoked.

  • revocation_authorstring

    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_typestring
    • MANUAL: This iteration was revoked manually.
    • INHERITED: This iteration inherited a revocation from an upstream ancestor and was revoked automatically.
  • revocation_inherited_fromobject
    • hrefstring

      The URL to get the revoked ancestor.

    • bucket_slugstring

      The revoked ancestor bucket slug.

    • iteration_incremental_versioninteger

      The revoked ancestor iteration incremental version.

    • iteration_idstring

      The revoked ancestor iteration ULID.

    • iteration_fingerprintstring

      The revoked ancestor iteration fingerprint.

  • has_descendantsboolean

    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_typestring
operationobject

Operation represents a single operation.

  • idstring

    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.

  • statestring

    State is one of the states that an Operation can be in.

    The states are purposely coarse grained to make it easy to understand the operation state machine: pending => running => done. Or pending => queued => running => done. No other state transitions are possible. Success/failure can be determined based on the result oneof.

  • errorobject

    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.

    • codeinteger

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

    • messagestring

      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.

    • detailsobject[]

      An arbitrary serialized message. Visit the protobufAny documentation for more information.

      • @typestring

        A URL that describes the type of the serialized message.

  • responseobject

    An arbitrary serialized message. Visit the protobufAny documentation for more information.

    • @typestring

      A URL that describes the type of the serialized message.

  • locationobject

    Location represents a target for an operation in HCP.

    • organization_idstring

      organization_id is the id of the organization.

    • project_idstring

      project_id is the projects id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
  • linkobject

    Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".

    • typestring

      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.

    • idstring

      id is the identifier for this resource.

    • uuidstring

      uuid is the unique UUID for this resource.

    • locationobject

      Location represents a target for an operation in HCP.

      • organization_idstring

        organization_id is the id of the organization.

      • project_idstring

        project_id is the projects id.

      • regionobject

        Region identifies a Cloud data-plane region.

        • providerstring
        • regionstring
    • descriptionstring

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

  • created_atstring

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

  • updated_atstring

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

Default Error Response
codeinteger

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

messagestring

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.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Get​Registry

get

​/​registry

​Get​Registry

https://api.cloud.hashicorp.com/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/registry

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

Query Parameters
location.region.providerstring

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

location.region.regionstring

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

Response

200 - OK
registryobject
  • idstring

    ULID of the registry.

  • locationobject

    Location represents a target for an operation in HCP.

    • organization_idstring

      organization_id is the id of the organization.

    • project_idstring

      project_id is the projects id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
  • configobject
    • feature_tierstring
    • activatedboolean

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

    • billing_deprovisionobject
      • atstring

        The time the registry was deactivated of billing.

      • reasonstring
    • tfc_run_task_configobject
      • api_idstring

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

      • hmac_keystring

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

  • created_atstring

    When the registry was created.

  • updated_atstring

    When the registry was last updated.

Default Error Response
codeinteger

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

messagestring

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.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Delete​Registry

delete

​/​registry

​Delete​Registry

https://api.cloud.hashicorp.com/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/registry

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

Query Parameters
location.region.providerstring

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

location.region.regionstring

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

hard_deleteboolean

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

Response

200 - OK
registryobject
  • idstring

    ULID of the registry.

  • locationobject

    Location represents a target for an operation in HCP.

    • organization_idstring

      organization_id is the id of the organization.

    • project_idstring

      project_id is the projects id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
  • configobject
    • feature_tierstring
    • activatedboolean

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

    • billing_deprovisionobject
      • atstring

        The time the registry was deactivated of billing.

      • reasonstring
    • tfc_run_task_configobject
      • api_idstring

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

      • hmac_keystring

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

  • created_atstring

    When the registry was created.

  • updated_atstring

    When the registry was last updated.

operationobject

Operation represents a single operation.

  • idstring

    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.

  • statestring

    State is one of the states that an Operation can be in.

    The states are purposely coarse grained to make it easy to understand the operation state machine: pending => running => done. Or pending => queued => running => done. No other state transitions are possible. Success/failure can be determined based on the result oneof.

  • errorobject

    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.

    • codeinteger

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

    • messagestring

      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.

    • detailsobject[]

      An arbitrary serialized message. Visit the protobufAny documentation for more information.

      • @typestring

        A URL that describes the type of the serialized message.

  • responseobject

    An arbitrary serialized message. Visit the protobufAny documentation for more information.

    • @typestring

      A URL that describes the type of the serialized message.

  • locationobject

    Location represents a target for an operation in HCP.

    • organization_idstring

      organization_id is the id of the organization.

    • project_idstring

      project_id is the projects id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
  • linkobject

    Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".

    • typestring

      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.

    • idstring

      id is the identifier for this resource.

    • uuidstring

      uuid is the unique UUID for this resource.

    • locationobject

      Location represents a target for an operation in HCP.

      • organization_idstring

        organization_id is the id of the organization.

      • project_idstring

        project_id is the projects id.

      • regionobject

        Region identifies a Cloud data-plane region.

        • providerstring
        • regionstring
    • descriptionstring

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

  • created_atstring

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

  • updated_atstring

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

Default Error Response
codeinteger

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

messagestring

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.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Create​Registry

put

​/​registry

​Create​Registry

https://api.cloud.hashicorp.com/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/registry

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

Body Parameters
locationobject

Location represents a target for an operation in HCP.

  • regionobject

    Region identifies a Cloud data-plane region.

    • providerstring
    • regionstring
feature_tierstring

Response

200 - OK
registryobject
  • idstring

    ULID of the registry.

  • locationobject

    Location represents a target for an operation in HCP.

    • organization_idstring

      organization_id is the id of the organization.

    • project_idstring

      project_id is the projects id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
  • configobject
    • feature_tierstring
    • activatedboolean

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

    • billing_deprovisionobject
      • atstring

        The time the registry was deactivated of billing.

      • reasonstring
    • tfc_run_task_configobject
      • api_idstring

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

      • hmac_keystring

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

  • created_atstring

    When the registry was created.

  • updated_atstring

    When the registry was last updated.

operationobject

Operation represents a single operation.

  • idstring

    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.

  • statestring

    State is one of the states that an Operation can be in.

    The states are purposely coarse grained to make it easy to understand the operation state machine: pending => running => done. Or pending => queued => running => done. No other state transitions are possible. Success/failure can be determined based on the result oneof.

  • errorobject

    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.

    • codeinteger

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

    • messagestring

      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.

    • detailsobject[]

      An arbitrary serialized message. Visit the protobufAny documentation for more information.

      • @typestring

        A URL that describes the type of the serialized message.

  • responseobject

    An arbitrary serialized message. Visit the protobufAny documentation for more information.

    • @typestring

      A URL that describes the type of the serialized message.

  • locationobject

    Location represents a target for an operation in HCP.

    • organization_idstring

      organization_id is the id of the organization.

    • project_idstring

      project_id is the projects id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
  • linkobject

    Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".

    • typestring

      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.

    • idstring

      id is the identifier for this resource.

    • uuidstring

      uuid is the unique UUID for this resource.

    • locationobject

      Location represents a target for an operation in HCP.

      • organization_idstring

        organization_id is the id of the organization.

      • project_idstring

        project_id is the projects id.

      • regionobject

        Region identifies a Cloud data-plane region.

        • providerstring
        • regionstring
    • descriptionstring

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

  • created_atstring

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

  • updated_atstring

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

Default Error Response
codeinteger

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

messagestring

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.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Update​Registry

patch

​/​registry

​Update​Registry

https://api.cloud.hashicorp.com/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/registry

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

Body Parameters
locationobject

Location represents a target for an operation in HCP.

  • regionobject

    Region identifies a Cloud data-plane region.

    • providerstring
    • regionstring
feature_tierstring
activateboolean

Activates a deactivated registry. A registry can only be activated if the organization billing account is valid (e.g. valid credits or payment method).

Response

200 - OK
registryobject
  • idstring

    ULID of the registry.

  • locationobject

    Location represents a target for an operation in HCP.

    • organization_idstring

      organization_id is the id of the organization.

    • project_idstring

      project_id is the projects id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
  • configobject
    • feature_tierstring
    • activatedboolean

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

    • billing_deprovisionobject
      • atstring

        The time the registry was deactivated of billing.

      • reasonstring
    • tfc_run_task_configobject
      • api_idstring

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

      • hmac_keystring

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

  • created_atstring

    When the registry was created.

  • updated_atstring

    When the registry was last updated.

operationobject

Operation represents a single operation.

  • idstring

    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.

  • statestring

    State is one of the states that an Operation can be in.

    The states are purposely coarse grained to make it easy to understand the operation state machine: pending => running => done. Or pending => queued => running => done. No other state transitions are possible. Success/failure can be determined based on the result oneof.

  • errorobject

    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.

    • codeinteger

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

    • messagestring

      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.

    • detailsobject[]

      An arbitrary serialized message. Visit the protobufAny documentation for more information.

      • @typestring

        A URL that describes the type of the serialized message.

  • responseobject

    An arbitrary serialized message. Visit the protobufAny documentation for more information.

    • @typestring

      A URL that describes the type of the serialized message.

  • locationobject

    Location represents a target for an operation in HCP.

    • organization_idstring

      organization_id is the id of the organization.

    • project_idstring

      project_id is the projects id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
  • linkobject

    Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".

    • typestring

      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.

    • idstring

      id is the identifier for this resource.

    • uuidstring

      uuid is the unique UUID for this resource.

    • locationobject

      Location represents a target for an operation in HCP.

      • organization_idstring

        organization_id is the id of the organization.

      • project_idstring

        project_id is the projects id.

      • regionobject

        Region identifies a Cloud data-plane region.

        • providerstring
        • regionstring
    • descriptionstring

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

  • created_atstring

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

  • updated_atstring

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

Default Error Response
codeinteger

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

messagestring

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.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Regenerate​T​F​C​Run​Task​Hmac​Key

patch

​/​runtasks​/​hmac

​Regenerate​T​F​C​Run​Task​Hmac​Key

https://api.cloud.hashicorp.com/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/runtasks/hmac

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

Body Parameters
locationobject

Location represents a target for an operation in HCP.

  • regionobject

    Region identifies a Cloud data-plane region.

    • providerstring
    • regionstring

Response

200 - OK
hmac_keystring

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

Default Error Response
codeinteger

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

messagestring

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.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Get​Registry​T​F​C​Run​Task​A​P​I

get

​/​runtasks​/​{task_type}

​Get​Registry​T​F​C​Run​Task​A​P​I

https://api.cloud.hashicorp.com/packer/2021-04-30/organizations/{location.organization_id}/projects/{location.project_id}/runtasks/{task_type}

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

task_typestringRequired

The HCP Packer Terraform Cloud run task type. Currently, the only existing type is validation.

Query Parameters
location.region.providerstring

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

location.region.regionstring

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

Response

200 - OK
api_urlstring

URL of the API used by Terraform Cloud to run HCP Packer Run Tasks.

hmac_keystring

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

Default Error Response
codeinteger

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

messagestring

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.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.