Missing registry API endpoint for Get Provider

[guineveresaenger]

Thank you for reporting an issue.

I can query a provider's information in the Terraform registry like so:

curl -i https://registry.terraform.io/v1/providers/hashicorp/random/3.6.3

which allows me to see metadata about the provider source.

When I do the same for OpenTofu, I get a 404:

curl -i https://registry.opentofu.org/v1/providers/hashicorp/random/3.6.3

It is entirely possible that this is an enhancement request rather than a bug, and the HashiCorp-owned registry is somewhat cagey around the providers service endpoints - but this is how I'd expect the registry protocol to behave.

Context here is I'd like to obtain the sourcecode repo via metadata rather than via assumed naming convention.

OpenTofu Version

n/a

OpenTofu Configuration Files

n/a

[abstractionfactory]

Hi @guineveresaenger we are implementing the documented provider registry protocol we inherited from HashiCorp, which does not expose an endpoint at this address. If you know which os and architecture you are looking for, you can use the https://registry.opentofu.org/v1/providers/hashicorp/random/3.6.3/download/linux/amd64 endpoint. Alternatively, you can clone the registry repository and access the data directly.

Could you elaborate on your use case for this endpoint? (Unfortunately, I cannot access the Terraform registry to check their data structure as this would violate their Terms of Service, so you'll have to describe what exactly you are looking for.)

[guineveresaenger]

Hi @abstractionfactory - thanks for the quick reply! 💟

I'm a little confused, as this endpoint is clearly accessible and public from the Terraform registry. You're right, though; this endpoint isn't documented in the registry protocol, so I figured it was an oversight.
I would expect both registry hosts to exhibit similar behavior, but of course if the spec isn't there, it's hard to implement.

My use case is this:

I would like to determine the source code location (i.e. githost/org/terraform-provider-foo) programmatically via the provider's registry endpoint, knowing a provider's OpenTofu name and version. I can infer it currently, assuming that the git host is always github.com and the org and module name always map to the namespace and type. But that's an assumption based on current most common (?) practice.

When I run

curl -i https://registry.terraform.io/v1/providers/hashicorp/random/3.6.3

I get back a 200 response, headers, and the following payload:

{
  "id": "hashicorp/random/3.6.3",
  "owner": "hashicorp",
  "namespace": "hashicorp",
  "name": "random",
  "alias": "random",
  "version": "3.6.3",
  "tag": "v3.6.3",
  "description": "terraform-provider-random",
  "source": "https://github.com/hashicorp/terraform-provider-random", 
  "published_at": "2024-09-11T14:08:43Z",
  "downloads": 1310537974,
  "tier": "official",
  "logo_url": "/images/providers/hashicorp.svg",
  "versions": [...]
  ...
  }

It's the source field I'm after.

Alternatively, you can clone the registry repository and access the data directly.

Unfortunately that won't generalize to all Terraform registries. 😅 but thank you for pointing it out.

[abstractionfactory]

This endpoint isn't documented indeed, which makes it unlikely that other registries will support it.

I don't see any problems generating this response, or we can add it to the new api.opentofu.org endpoint (still in beta).

I'll talk to my fellow core team members and we'll try to make a decision on this fairly quickly.

[guineveresaenger]

That's a fair point about other registries. I should file an issue against the registry protocol to at least get clarification here.

Thank you so much for considering! ❤️

[abstractionfactory]

@guineveresaenger I just did a quick check and the OpenTofu API may contain the information you seek:

https://api.opentofu.org/registry/docs/providers/opentofu/aws/v5.78.0/index.json (See the link field.)

You can find the API description at https://api.opentofu.org