Ctrlk
Sign UpGet a DemoContact Us
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Provider Registry

The provider-registry service implements HashiCorp's Provider Registry Protocol for private Terraform providers

List providers

get

Lists all providers for an account

Query parameters
limitinteger · int64 · min: 1 · max: 1000Optional

Limit is the number of records to return for a page.

Default: 30Example: 30
pageinteger · int64 · min: 1Optional

Page is the page number to return relative to the page 'limit'.

Default: 1Example: 1
searchTermstringOptional

Filter results by partial name match

Default: ""Example: mymod
sortstring · enumOptional

Sort order for results

Default: name,ASCExample: name,DESCPossible values:
Header parameters
Harness-AccountstringRequired

Account name

Example: Mollitia voluptates porro fugit et placeat.
Responses
200

OK response.

application/json
get/api/providers
GET /api/providers HTTP/1.1
Host: localhost:80
Harness-Account: Mollitia voluptates porro fugit et placeat.
Accept: */*

[
  {
    "account": "Placeat quisquam accusantium ut sit dolorem.",
    "created": 2916135127727153000,
    "description": "Eos omnis numquam impedit eos aut qui.",
    "domain_prefix": "Rerum dolor at et vero autem.",
    "id": "Unde sit voluptates.",
    "namespace": "Voluptas temporibus et vel non ut velit.",
    "type": "Qui et repellendus.",
    "updated": 7184896169060094000,
    "versions": [
      {
        "files": [
          "Qui doloremque et odit et officiis aut.",
          "Amet tempore qui repellat impedit repellat."
        ],
        "synced": false,
        "tier": "Et modi et et.",
        "version": "Rerum voluptatem odio in cupiditate rem harum."
      },
      {
        "files": [
          "Qui doloremque et odit et officiis aut.",
          "Amet tempore qui repellat impedit repellat."
        ],
        "synced": false,
        "tier": "Et modi et et.",
        "version": "Rerum voluptatem odio in cupiditate rem harum."
      },
      {
        "files": [
          "Qui doloremque et odit et officiis aut.",
          "Amet tempore qui repellat impedit repellat."
        ],
        "synced": false,
        "tier": "Et modi et et.",
        "version": "Rerum voluptatem odio in cupiditate rem harum."
      },
      {
        "files": [
          "Qui doloremque et odit et officiis aut.",
          "Amet tempore qui repellat impedit repellat."
        ],
        "synced": false,
        "tier": "Et modi et et.",
        "version": "Rerum voluptatem odio in cupiditate rem harum."
      }
    ]
  },
  {
    "account": "Placeat quisquam accusantium ut sit dolorem.",
    "created": 2916135127727153000,
    "description": "Eos omnis numquam impedit eos aut qui.",
    "domain_prefix": "Rerum dolor at et vero autem.",
    "id": "Unde sit voluptates.",
    "namespace": "Voluptas temporibus et vel non ut velit.",
    "type": "Qui et repellendus.",
    "updated": 7184896169060094000,
    "versions": [
      {
        "files": [
          "Qui doloremque et odit et officiis aut.",
          "Amet tempore qui repellat impedit repellat."
        ],
        "synced": false,
        "tier": "Et modi et et.",
        "version": "Rerum voluptatem odio in cupiditate rem harum."
      },
      {
        "files": [
          "Qui doloremque et odit et officiis aut.",
          "Amet tempore qui repellat impedit repellat."
        ],
        "synced": false,
        "tier": "Et modi et et.",
        "version": "Rerum voluptatem odio in cupiditate rem harum."
      },
      {
        "files": [
          "Qui doloremque et odit et officiis aut.",
          "Amet tempore qui repellat impedit repellat."
        ],
        "synced": false,
        "tier": "Et modi et et.",
        "version": "Rerum voluptatem odio in cupiditate rem harum."
      },
      {
        "files": [
          "Qui doloremque et odit et officiis aut.",
          "Amet tempore qui repellat impedit repellat."
        ],
        "synced": false,
        "tier": "Et modi et et.",
        "version": "Rerum voluptatem odio in cupiditate rem harum."
      }
    ]
  },
  {
    "account": "Placeat quisquam accusantium ut sit dolorem.",
    "created": 2916135127727153000,
    "description": "Eos omnis numquam impedit eos aut qui.",
    "domain_prefix": "Rerum dolor at et vero autem.",
    "id": "Unde sit voluptates.",
    "namespace": "Voluptas temporibus et vel non ut velit.",
    "type": "Qui et repellendus.",
    "updated": 7184896169060094000,
    "versions": [
      {
        "files": [
          "Qui doloremque et odit et officiis aut.",
          "Amet tempore qui repellat impedit repellat."
        ],
        "synced": false,
        "tier": "Et modi et et.",
        "version": "Rerum voluptatem odio in cupiditate rem harum."
      },
      {
        "files": [
          "Qui doloremque et odit et officiis aut.",
          "Amet tempore qui repellat impedit repellat."
        ],
        "synced": false,
        "tier": "Et modi et et.",
        "version": "Rerum voluptatem odio in cupiditate rem harum."
      },
      {
        "files": [
          "Qui doloremque et odit et officiis aut.",
          "Amet tempore qui repellat impedit repellat."
        ],
        "synced": false,
        "tier": "Et modi et et.",
        "version": "Rerum voluptatem odio in cupiditate rem harum."
      },
      {
        "files": [
          "Qui doloremque et odit et officiis aut.",
          "Amet tempore qui repellat impedit repellat."
        ],
        "synced": false,
        "tier": "Et modi et et.",
        "version": "Rerum voluptatem odio in cupiditate rem harum."
      }
    ]
  },
  {
    "account": "Placeat quisquam accusantium ut sit dolorem.",
    "created": 2916135127727153000,
    "description": "Eos omnis numquam impedit eos aut qui.",
    "domain_prefix": "Rerum dolor at et vero autem.",
    "id": "Unde sit voluptates.",
    "namespace": "Voluptas temporibus et vel non ut velit.",
    "type": "Qui et repellendus.",
    "updated": 7184896169060094000,
    "versions": [
      {
        "files": [
          "Qui doloremque et odit et officiis aut.",
          "Amet tempore qui repellat impedit repellat."
        ],
        "synced": false,
        "tier": "Et modi et et.",
        "version": "Rerum voluptatem odio in cupiditate rem harum."
      },
      {
        "files": [
          "Qui doloremque et odit et officiis aut.",
          "Amet tempore qui repellat impedit repellat."
        ],
        "synced": false,
        "tier": "Et modi et et.",
        "version": "Rerum voluptatem odio in cupiditate rem harum."
      },
      {
        "files": [
          "Qui doloremque et odit et officiis aut.",
          "Amet tempore qui repellat impedit repellat."
        ],
        "synced": false,
        "tier": "Et modi et et.",
        "version": "Rerum voluptatem odio in cupiditate rem harum."
      },
      {
        "files": [
          "Qui doloremque et odit et officiis aut.",
          "Amet tempore qui repellat impedit repellat."
        ],
        "synced": false,
        "tier": "Et modi et et.",
        "version": "Rerum voluptatem odio in cupiditate rem harum."
      }
    ]
  }
]

Get provider

get

Gets a provider by ID

Path parameters
idstringRequired

Provider ID

Example: Possimus sed omnis.
Header parameters
Harness-AccountstringRequired

Account name

Example: Minima dolores aut animi.
Responses
200

OK response.

application/json

Provider

accountstringRequired

Account that owns the provider

Example: Maiores vel.
createdinteger · int64Required

Created is the unix timestamp at which the resource was originally created in milliseconds.

Example: 6506972038301882000
descriptionstringRequired

Description of the provider

Example: Sequi dolore.
domain_prefixstringOptional

Domain prefix of the provider

Example: Quia cum.
idstringRequired

Provider ID

Example: Hic quo consectetur ipsa eos quidem.
namespacestringOptional

Provider namespace

Example: Ut qui assumenda natus aut placeat corrupti.
typestringRequired

Provider type

Example: Voluptas ipsam ea ipsam recusandae est.
updatedinteger · int64Required

Modified is the unix timestamp at which the resource was last modified in milliseconds.

Example: 4938034356948910000
get/api/providers/{id}
GET /api/providers/{id} HTTP/1.1
Host: localhost:80
Harness-Account: Minima dolores aut animi.
Accept: */*

{
  "account": "Vel sequi voluptas facere voluptatum ab assumenda.",
  "created": 6018121395652762000,
  "description": "Fuga soluta dignissimos vel autem.",
  "domain_prefix": "Error fuga aspernatur id esse odit.",
  "id": "Repellendus maiores.",
  "namespace": "Voluptatem natus cupiditate quae quia.",
  "type": "Qui dolorem quis recusandae a.",
  "updated": 9016035203648122000,
  "versions": [
    {
      "files": [
        "Tempore est accusamus molestiae.",
        "Odit ut animi veniam est molestiae cum.",
        "Doloribus et blanditiis."
      ],
      "synced": false,
      "tier": "Consequatur cum aliquam similique consequatur odio quasi.",
      "version": "Saepe harum."
    },
    {
      "files": [
        "Tempore est accusamus molestiae.",
        "Odit ut animi veniam est molestiae cum.",
        "Doloribus et blanditiis."
      ],
      "synced": false,
      "tier": "Consequatur cum aliquam similique consequatur odio quasi.",
      "version": "Saepe harum."
    },
    {
      "files": [
        "Tempore est accusamus molestiae.",
        "Odit ut animi veniam est molestiae cum.",
        "Doloribus et blanditiis."
      ],
      "synced": false,
      "tier": "Consequatur cum aliquam similique consequatur odio quasi.",
      "version": "Saepe harum."
    },
    {
      "files": [
        "Tempore est accusamus molestiae.",
        "Odit ut animi veniam est molestiae cum.",
        "Doloribus et blanditiis."
      ],
      "synced": false,
      "tier": "Consequatur cum aliquam similique consequatur odio quasi.",
      "version": "Saepe harum."
    }
  ]
}

Delete provider

delete

Deletes a provider

Path parameters
idstringRequired

Provider ID

Example: Sunt in magnam esse reprehenderit.
Header parameters
Harness-AccountstringRequired

Account name

Example: Reiciendis rem in optio.
Responses
200

OK response.

No content
delete/api/providers/{id}
DELETE /api/providers/{id} HTTP/1.1
Host: localhost:80
Harness-Account: Reiciendis rem in optio.
Accept: */*

No content

Get provider lifecycle rule

get

Get the lifecycle rule for a provider

Path parameters
idstringRequired

Provider ID

Example: Tempora asperiores repellat.
Header parameters
Harness-AccountstringRequired

Account name

Example: Accusantium ipsam amet ducimus laboriosam non.
Responses
200

OK response.

application/json
deprecated_actionstring · enumRequired

Enforcement action for deprecated-tier versions

Default: failExample: warnPossible values:
supported_actionstring · enumRequired

Enforcement action for supported-tier versions

Default: no_actionExample: no_actionPossible values:
supported_countinteger · int64 · min: 1Required

Number of most-recent non-pre-release versions classified as supported

Example: 3
warning_actionstring · enumRequired

Enforcement action for warning-tier versions

Default: warnExample: warnPossible values:
warning_countinteger · int64Required

Number of versions immediately after the supported window classified as warning

Example: 2
get/api/providers/{id}/lifecycle
GET /api/providers/{id}/lifecycle HTTP/1.1
Host: localhost:80
Harness-Account: Accusantium ipsam amet ducimus laboriosam non.
Accept: */*

{
  "deprecated_action": "fail",
  "overrides": [
    {
      "reason": "gqh",
      "tier": "supported",
      "version": "v2.1.0"
    },
    {
      "reason": "gqh",
      "tier": "supported",
      "version": "v2.1.0"
    },
    {
      "reason": "gqh",
      "tier": "supported",
      "version": "v2.1.0"
    }
  ],
  "supported_action": "fail",
  "supported_count": 3,
  "warning_action": "fail",
  "warning_count": 2
}

Upsert provider lifecycle rule

put

Create or replace the lifecycle rule for a provider, atomically replacing all overrides

Path parameters
idstringRequired

Provider ID

Example: Reiciendis nisi omnis nesciunt nihil nisi voluptatum.
Header parameters
Harness-AccountstringRequired

Account name

Example: Quasi illum fugit veniam voluptatem.
Body

Lifecycle rule configuration for a provider registry provider

deprecated_actionstring · enumRequired

Enforcement action for deprecated-tier versions

Default: failExample: warnPossible values:
supported_actionstring · enumRequired

Enforcement action for supported-tier versions

Default: no_actionExample: failPossible values:
supported_countinteger · int64 · min: 1Required

Number of most-recent non-pre-release versions classified as supported

Example: 3
warning_actionstring · enumRequired

Enforcement action for warning-tier versions

Default: warnExample: no_actionPossible values:
warning_countinteger · int64Required

Number of versions immediately after the supported window classified as warning

Example: 2
Responses
200

OK response.

application/json
deprecated_actionstring · enumRequired

Enforcement action for deprecated-tier versions

Default: failExample: failPossible values:
supported_actionstring · enumRequired

Enforcement action for supported-tier versions

Default: no_actionExample: failPossible values:
supported_countinteger · int64 · min: 1Required

Number of most-recent non-pre-release versions classified as supported

Example: 3
warning_actionstring · enumRequired

Enforcement action for warning-tier versions

Default: warnExample: no_actionPossible values:
warning_countinteger · int64Required

Number of versions immediately after the supported window classified as warning

Example: 2
put/api/providers/{id}/lifecycle
PUT /api/providers/{id}/lifecycle HTTP/1.1
Host: localhost:80
Harness-Account: Quasi illum fugit veniam voluptatem.
Content-Type: application/json
Accept: */*
Content-Length: 294

{
  "deprecated_action": "warn",
  "overrides": [
    {
      "reason": "5pr",
      "tier": "warning",
      "version": "v2.1.0"
    },
    {
      "reason": "5pr",
      "tier": "warning",
      "version": "v2.1.0"
    },
    {
      "reason": "5pr",
      "tier": "warning",
      "version": "v2.1.0"
    }
  ],
  "supported_action": "fail",
  "supported_count": 3,
  "warning_action": "no_action",
  "warning_count": 2
}
{
  "deprecated_action": "fail",
  "overrides": [
    {
      "reason": "gqh",
      "tier": "supported",
      "version": "v2.1.0"
    },
    {
      "reason": "gqh",
      "tier": "supported",
      "version": "v2.1.0"
    },
    {
      "reason": "gqh",
      "tier": "supported",
      "version": "v2.1.0"
    }
  ],
  "supported_action": "warn",
  "supported_count": 3,
  "warning_action": "no_action",
  "warning_count": 2
}

Delete provider lifecycle rule

delete

Delete the lifecycle rule and all overrides for a provider; all versions revert to supported

Path parameters
idstringRequired

Provider ID

Example: Ullam optio voluptatem.
Header parameters
Harness-AccountstringRequired

Account name

Example: Perspiciatis dolorem corporis odit sequi laudantium.
Responses
204

No Content response.

No content
delete/api/providers/{id}/lifecycle
DELETE /api/providers/{id}/lifecycle HTTP/1.1
Host: localhost:80
Harness-Account: Perspiciatis dolorem corporis odit sequi laudantium.
Accept: */*

No content

Get provider version lifecycle status

get

Compute the lifecycle tier and enforcement action for a specific provider version

Path parameters
idstringRequired

Provider ID

Example: Cumque mollitia repellat quam.
versionstringRequired

Version to look up

Example: Assumenda omnis sunt.
Header parameters
Harness-AccountstringRequired

Account name

Example: Eius sunt est quos nam architecto.
Responses
200

OK response.

application/json
actionstring · enumRequired

Enforcement action derived from the tier's rule action

Example: failPossible values:
minimum_supported_versionstringOptional

The lowest-numbered version currently in the supported tier

Example: Quae neque praesentium laborum eum mollitia ut.
tierstring · enumRequired

Lifecycle tier: supported, warning, or deprecated

Example: deprecatedPossible values:
get/api/providers/{id}/lifecycle/versions/{version}
GET /api/providers/{id}/lifecycle/versions/{version} HTTP/1.1
Host: localhost:80
Harness-Account: Eius sunt est quos nam architecto.
Accept: */*

{
  "action": "warn",
  "minimum_supported_version": "Doloribus harum qui quia amet quidem.",
  "tier": "warning"
}

Create provider version

post

Create a provider version

Path parameters
idstringRequired

Provider ID

Example: 1
Header parameters
Harness-AccountstringRequired

Account ID

Example: harness
Body
gpg_key_idstringRequired

GPG key ID

Example: 1234567890
protocolstring[]Required

Supported Terraform protocol versions

Example: ["4.0"]
versionstringRequired

Provider version

Example: 1.0.0
Responses
201

Created response.

No content
post/api/providers/{id}/version
POST /api/providers/{id}/version HTTP/1.1
Host: localhost:80
Harness-Account: harness
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "gpg_key_id": "1234567890",
  "protocol": [
    "4.0"
  ],
  "version": "1.0.0"
}
No content

Get provider version

get

Get a provider version

Path parameters
idstringRequired

Provider ID

Example: 1
versionstringRequired

Provider version

Example: 1.0.0
Header parameters
Harness-AccountstringRequired

Account ID

Example: harness
Responses
200

OK response.

application/json
gpg_key_idstringRequired

GPG key ID

Example: 1234567890
idstringRequired

Provider version ID

Example: 1
protocolsstring[]Required

Supported Terraform protocol versions

Example: ["4.0"]
get/api/providers/{id}/version/{version}
GET /api/providers/{id}/version/{version} HTTP/1.1
Host: localhost:80
Harness-Account: harness
Accept: */*

{
  "gpg_key_id": "1234567890",
  "id": "1",
  "protocols": [
    "4.0"
  ]
}

Update provider version

put

Update a provider version

Path parameters
idstringRequired

Provider ID

Example: 1
versionstringRequired

Provider version

Example: 1.0.0
Header parameters
Harness-AccountstringRequired

Account ID

Example: harness
Body
gpg_key_idstringRequired

GPG key ID

Example: 1234567890
protocolstring[]Required

Supported Terraform protocol versions

Example: ["4.0"]
Responses
200

OK response.

No content
put/api/providers/{id}/version/{version}
PUT /api/providers/{id}/version/{version} HTTP/1.1
Host: localhost:80
Harness-Account: harness
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "gpg_key_id": "1234567890",
  "protocol": [
    "4.0"
  ]
}
No content

Delete provider version

delete

Delete a provider version

Path parameters
idstringRequired

Provider ID

Example: 1
versionstringRequired

Provider version

Example: 1.0.0
Header parameters
Harness-AccountstringRequired

Account ID

Example: harness
Responses
200

OK response.

No content
delete/api/providers/{id}/version/{version}
DELETE /api/providers/{id}/version/{version} HTTP/1.1
Host: localhost:80
Harness-Account: harness
Accept: */*

No content

Delete file from a non synced provider version

delete

Delete a file from a non synced provider version

Path parameters
idstringRequired

Provider ID

Example: 1
versionstringRequired

Provider version

Example: 1.0.0
filenamestringRequired

File name

Example: file.txt
Header parameters
Harness-AccountstringRequired

Account ID

Example: harness
Responses
204

No Content response.

No content
delete/api/providers/{id}/version/{version}/file/{filename}
DELETE /api/providers/{id}/version/{version}/file/{filename} HTTP/1.1
Host: localhost:80
Harness-Account: harness
Accept: */*

No content

Upload files

post

Upload files to the provider registry

Path parameters
idstringRequired

Provider ID

Example: terraform
versionstringRequired

Provider version

Example: 1.0.0
Header parameters
Harness-AccountstringRequired

Account ID

Example: harness
Content-DispositionstringRequired

Content-Disposition header

Example: Voluptatem ratione velit est dolores mollitia rerum.
Responses
201

Created response.

application/json
syncedbooleanOptional

Indicates if the provider version is synced

Example: false
post/api/providers/{id}/version/{version}/files
POST /api/providers/{id}/version/{version}/files HTTP/1.1
Host: localhost:80
Harness-Account: harness
Content-Disposition: Voluptatem ratione velit est dolores mollitia rerum.
Accept: */*

{
  "synced": false
}

Publish a provider version

post

Publish a provider version

Path parameters
idstringRequired

Provider ID

Example: 1
versionstringRequired

Provider version

Example: 1.0.0
Header parameters
Harness-AccountstringRequired

Account ID

Example: harness
Responses
200

OK response.

No content
post/api/providers/{id}/version/{version}/publish
POST /api/providers/{id}/version/{version}/publish HTTP/1.1
Host: localhost:80
Harness-Account: harness
Accept: */*

No content

Create provider

post

Create a provider

Path parameters
typestringRequired

Provider type

Example: terraform
Header parameters
Harness-AccountstringRequired

Account ID

Example: harness
Body
descriptionstringOptional

Provider description

Example: Terraform provider
Responses
201

Created response.

application/json
idstringRequired

Provider ID

Example: 1
post/api/providers/{type}
POST /api/providers/{type} HTTP/1.1
Host: localhost:80
Harness-Account: harness
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "description": "Terraform provider"
}
{
  "id": "1"
}

Get the provider domain

get

Get the provider domain

Header parameters
Harness-AccountstringRequired

Account ID

Example: harness
Responses
200

OK response.

application/json
domainstringRequired

Domain

Example: Molestiae deserunt in illum perspiciatis iusto sapiente.
get/api/providers/get-provider-domain
GET /api/providers/get-provider-domain HTTP/1.1
Host: localhost:80
Harness-Account: harness
Accept: */*

{
  "domain": "Quia odit ipsa vitae inventore earum."
}

List signing keys

get

List all GPG signing keys for an account

Query parameters
limitinteger · int64 · min: 1 · max: 1000Optional

Limit is the number of records to return for a page.

Default: 30Example: 30
pageinteger · int64 · min: 1Optional

Page is the page number to return relative to the page 'limit'.

Default: 1Example: 1
searchTermstringOptional

Filter results by partial name match

Default: ""Example: mymod
sortstring · enumOptional

Sort order for results

Default: name,ASCExample: name,DESCPossible values:
Header parameters
Harness-AccountstringRequired

Account ID

Example: harness
Responses
200

OK response.

application/json
get/api/providers/keys
GET /api/providers/keys HTTP/1.1
Host: localhost:80
Harness-Account: harness
Accept: */*

[
  {
    "ascii_armor": "Rerum ea quasi in culpa.",
    "created_at": "Et dolorum quia architecto enim cupiditate voluptate.",
    "id": "Nemo repellat ea atque placeat voluptatem.",
    "key_id": "Ducimus sapiente et qui placeat id commodi.",
    "key_name": "Ut ipsum et nihil iste aperiam.",
    "updated_at": "Modi aliquid et porro asperiores beatae.",
    "user": "Vel nihil nisi cupiditate ex autem."
  },
  {
    "ascii_armor": "Rerum ea quasi in culpa.",
    "created_at": "Et dolorum quia architecto enim cupiditate voluptate.",
    "id": "Nemo repellat ea atque placeat voluptatem.",
    "key_id": "Ducimus sapiente et qui placeat id commodi.",
    "key_name": "Ut ipsum et nihil iste aperiam.",
    "updated_at": "Modi aliquid et porro asperiores beatae.",
    "user": "Vel nihil nisi cupiditate ex autem."
  },
  {
    "ascii_armor": "Rerum ea quasi in culpa.",
    "created_at": "Et dolorum quia architecto enim cupiditate voluptate.",
    "id": "Nemo repellat ea atque placeat voluptatem.",
    "key_id": "Ducimus sapiente et qui placeat id commodi.",
    "key_name": "Ut ipsum et nihil iste aperiam.",
    "updated_at": "Modi aliquid et porro asperiores beatae.",
    "user": "Vel nihil nisi cupiditate ex autem."
  },
  {
    "ascii_armor": "Rerum ea quasi in culpa.",
    "created_at": "Et dolorum quia architecto enim cupiditate voluptate.",
    "id": "Nemo repellat ea atque placeat voluptatem.",
    "key_id": "Ducimus sapiente et qui placeat id commodi.",
    "key_name": "Ut ipsum et nihil iste aperiam.",
    "updated_at": "Modi aliquid et porro asperiores beatae.",
    "user": "Vel nihil nisi cupiditate ex autem."
  }
]

Upload signing key

post

Upload a GPG signing key for an account

Header parameters
Harness-AccountstringRequired

Account ID

Example: harness
Body
ascii_armorstringRequired

ASCII-armored GPG public key

Example: Error mollitia voluptate provident fugit delectus.
key_idstringRequired

GPG key ID

Example: ABCD1234
key_namestringRequired

GPG key name

Example: harness
userstringRequired

User who uploaded the key

Example: Quos ut nulla quia qui pariatur.
Responses
201

Created response.

No content
post/api/providers/keys
POST /api/providers/keys HTTP/1.1
Host: localhost:80
Harness-Account: harness
Content-Type: application/json
Accept: */*
Content-Length: 135

{
  "ascii_armor": "Repellat quo sapiente.",
  "key_id": "ABCD1234",
  "key_name": "harness",
  "user": "Culpa doloremque porro aut omnis beatae non."
}
No content

Update a signing key for a provider

put

Update a signing key for a provider

Path parameters
idstringRequired

id of the key in the db

Example: 1
Header parameters
Harness-AccountstringRequired

Account ID

Example: harness
Body
ascii_armorstringRequired

ASCII-armored GPG public key

Example: Error mollitia voluptate provident fugit delectus.
key_idstringRequired

GPG key ID

Example: ABCD1234
key_namestringRequired

GPG key name

Example: harness
userstringRequired

User who uploaded the key

Example: Quos ut nulla quia qui pariatur.
Responses
200

OK response.

No content
put/api/providers/keys/{id}
PUT /api/providers/keys/{id} HTTP/1.1
Host: localhost:80
Harness-Account: harness
Content-Type: application/json
Accept: */*
Content-Length: 120

{
  "ascii_armor": "Dolores aut et nulla sit consequatur voluptatem.",
  "key_id": "ABCD1234",
  "key_name": "harness",
  "user": "foo"
}
No content

Delete a signing key for a provider

delete

Delete a signing key for a provider

Path parameters
idstringRequired

id of the key in the db

Example: 1
Header parameters
Harness-AccountstringRequired

Account ID

Example: harness
Responses
204

No Content response.

No content
delete/api/providers/keys/{id}
DELETE /api/providers/keys/{id} HTTP/1.1
Host: localhost:80
Harness-Account: harness
Accept: */*

No content

Batch check provider lifecycle status

post

Batch-check lifecycle status for a list of providers resolved during terraform init; only violations are returned

Header parameters
Harness-AccountstringRequired

Harness account ID

Example: Quisquam voluptatem hic facilis nobis.
Body
Responses
200

OK response.

application/json
post/api/providers/lifecycle/batch-check
POST /api/providers/lifecycle/batch-check HTTP/1.1
Host: localhost:80
Harness-Account: Quisquam voluptatem hic facilis nobis.
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "items": [
    {
      "namespace": "9vu",
      "type": "1",
      "version": "3q"
    }
  ]
}
{
  "results": [
    {
      "action": "warn",
      "minimum_supported_version": "Aspernatur ea illo.",
      "namespace": "Ipsum dolores enim dolorem nam.",
      "tier": "warning",
      "type": "Animi iusto beatae porro.",
      "version": "Fuga architecto est."
    },
    {
      "action": "warn",
      "minimum_supported_version": "Aspernatur ea illo.",
      "namespace": "Ipsum dolores enim dolorem nam.",
      "tier": "warning",
      "type": "Animi iusto beatae porro.",
      "version": "Fuga architecto est."
    }
  ]
}

Get provider download information

get

Returns download information for a specific provider version and platform

Path parameters
accountstringRequired

Account that owns the provider

Example: Ea beatae.
typestringRequired

Provider type

Example: Rerum dolores.
versionstringRequired

Provider version

Example: Esse qui.
osstringRequired

Operating system

Example: Molestiae rerum illo quae sed inventore.
archstringRequired

Architecture

Example: Similique id qui dolor voluptas perspiciatis.
Responses
200

OK response.

application/json

Provider download information

archstringRequired

Architecture

Example: Vel qui rem voluptatem eveniet delectus.
download_urlstringRequired

URL to download the provider binary

Example: Occaecati voluptatem quia ut odit molestias.
filenamestringRequired

Provider binary filename

Example: Necessitatibus commodi ad.
osstringRequired

Operating system

Example: Animi quas ea aut laborum.
protocolsstring[]Required

Supported Terraform protocol versions

Example: ["Excepturi non totam maiores repellat quis.","Esse vel quis.","Unde aut."]
shasumstringRequired

SHA256 checksum of the provider binary

Example: Vel alias delectus.
shasums_signature_urlstringRequired

URL to download the checksums signature

Example: Facilis magnam at sed est.
shasums_urlstringRequired

URL to download the checksums file

Example: Qui commodi iusto tempore.
get/provider/account/{account}/{type}/{version}/download/{os}/{arch}
GET /provider/account/{account}/{type}/{version}/download/{os}/{arch} HTTP/1.1
Host: localhost:80
Accept: */*

{
  "arch": "Quod molestiae.",
  "download_url": "Sit rerum itaque iusto et.",
  "filename": "Quo ad.",
  "os": "Harum ab rem sint porro.",
  "protocols": [
    "Eum ut occaecati illum est in eos.",
    "Qui pariatur error.",
    "Sequi repellat ea error.",
    "Animi tempore est quis dolorem tempora ut."
  ],
  "shasum": "Ipsam maxime aut hic quaerat.",
  "shasums_signature_url": "Recusandae maxime in placeat eveniet fugiat.",
  "shasums_url": "Tempora dolores quod ea rem autem.",
  "signing_keys": {
    "gpg_public_keys": [
      {
        "ascii_armor": "Ut praesentium eaque dolorum repellat.",
        "key_id": "Quidem deleniti temporibus quam non necessitatibus aliquam."
      },
      {
        "ascii_armor": "Ut praesentium eaque dolorum repellat.",
        "key_id": "Quidem deleniti temporibus quam non necessitatibus aliquam."
      },
      {
        "ascii_armor": "Ut praesentium eaque dolorum repellat.",
        "key_id": "Quidem deleniti temporibus quam non necessitatibus aliquam."
      }
    ]
  }
}

Get provider file

get

Download a provider file (binary, checksums, or signature)

Path parameters
accountstringRequired

Account identifier

Example: Tempore voluptas sit.
typestringRequired

Provider type

Example: Est a voluptates.
versionstringRequired

Provider version

Example: Recusandae in.
osstringRequired

Operating system

Example: Omnis enim quo.
archstringRequired

Architecture

Example: Ut atque quis.
filetypestring · enumRequired

Type of file to download

Example: binaryPossible values:
Query parameters
tokenstringRequired

Token to access the file

Example: Et dolor.
Responses
200

OK response.

application/json
Responsestring · binary
get/provider/account/{account}/{type}/{version}/download/{os}/{arch}/{filetype}
GET /provider/account/{account}/{type}/{version}/download/{os}/{arch}/{filetype}?token=Et+dolor. HTTP/1.1
Host: localhost:80
Accept: */*

binary

List provider versions

get

Lists available versions for a provider

Path parameters
accountstringRequired

Account that owns the provider

Example: Vitae quaerat voluptatibus corporis praesentium.
typestringRequired

Provider type

Example: Soluta vel praesentium.
Responses
200

OK response.

application/json

List of provider versions

get/provider/account/{account}/{type}/versions
GET /provider/account/{account}/{type}/versions HTTP/1.1
Host: localhost:80
Accept: */*

{
  "versions": [
    {
      "platforms": [
        {
          "arch": "Fugit quae.",
          "os": "Et sint maiores."
        },
        {
          "arch": "Fugit quae.",
          "os": "Et sint maiores."
        },
        {
          "arch": "Fugit quae.",
          "os": "Et sint maiores."
        }
      ],
      "protocols": [
        "Mollitia fugiat voluptas.",
        "Accusantium quaerat.",
        "Cupiditate iste in beatae et."
      ],
      "version": "Quia facilis enim dolores omnis nemo dolorem."
    },
    {
      "platforms": [
        {
          "arch": "Fugit quae.",
          "os": "Et sint maiores."
        },
        {
          "arch": "Fugit quae.",
          "os": "Et sint maiores."
        },
        {
          "arch": "Fugit quae.",
          "os": "Et sint maiores."
        }
      ],
      "protocols": [
        "Mollitia fugiat voluptas.",
        "Accusantium quaerat.",
        "Cupiditate iste in beatae et."
      ],
      "version": "Quia facilis enim dolores omnis nemo dolorem."
    },
    {
      "platforms": [
        {
          "arch": "Fugit quae.",
          "os": "Et sint maiores."
        },
        {
          "arch": "Fugit quae.",
          "os": "Et sint maiores."
        },
        {
          "arch": "Fugit quae.",
          "os": "Et sint maiores."
        }
      ],
      "protocols": [
        "Mollitia fugiat voluptas.",
        "Accusantium quaerat.",
        "Cupiditate iste in beatae et."
      ],
      "version": "Quia facilis enim dolores omnis nemo dolorem."
    },
    {
      "platforms": [
        {
          "arch": "Fugit quae.",
          "os": "Et sint maiores."
        },
        {
          "arch": "Fugit quae.",
          "os": "Et sint maiores."
        },
        {
          "arch": "Fugit quae.",
          "os": "Et sint maiores."
        }
      ],
      "protocols": [
        "Mollitia fugiat voluptas.",
        "Accusantium quaerat.",
        "Cupiditate iste in beatae et."
      ],
      "version": "Quia facilis enim dolores omnis nemo dolorem."
    }
  ]
}
PreviousModule Registry
NextRegistries

Last updated

Was this helpful?