{"openapi":"3.1.0","info":{"title":"HCP Terraform Registry (BYOK) API","version":"0.1.0","description":"HCP Terraform Registry (BYOK) lets an AI assistant read your own HCP Terraform Registry data through the HCP Terraform Registry API with a key you supply (user, team or organization API token). Read-only: 6 tools (list_registry_modules, get_registry_module, list_module_versions, list_registry_providers, get_registry_provider, list_provider_versions). The BYOK key travels with each request, is...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-hcp-terraform-registry.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-hcp-terraform-registry/docs"},"termsOfService":"https://connectorbay.com/byok-hcp-terraform-registry/terms"},"servers":[{"url":"https://byok-hcp-terraform-registry.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-hcp-terraform-registry/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_registry_modules":{"post":{"operationId":"list_registry_modules","summary":"List the modules available to an organization (private modules and curated public ones) with provider, status and versio","description":"List the modules available to an organization (private modules and curated public ones) with provider, status and version statuses. Use for \"Which private Terraform modules does my organization publish\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization":{"description":"HCP Terraform organization name, as returned by list_organizations in the HCP Terraform connector.","maxLength":100,"title":"Organization","type":"string"},"search":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Search text matched against module name, namespace and provider.","title":"Search"},"registry":{"anyOf":[{"enum":["private","public"],"type":"string"},{"type":"null"}],"default":null,"description":"Only modules of this registry.","title":"Registry"},"provider":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only modules for this provider, for example aws.","title":"Provider"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Items per page (1 to 100, default 20).","title":"Page Size"},"page_number":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page Number"}},"required":["organization"],"title":"list_registry_modulesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_registry_module":{"post":{"operationId":"get_registry_module","summary":"Get one registry module: status, version statuses, version tags, timestamps and the VCS repository it is published from.","description":"Get one registry module: status, version statuses, version tags, timestamps and the VCS repository it is published from. Use for \"Show the vpc module for aws in my HCP Terraform private registry\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization":{"description":"HCP Terraform organization name, as returned by list_organizations in the HCP Terraform connector.","maxLength":100,"title":"Organization","type":"string"},"registry_name":{"description":"Which registry: private (modules and providers your organization published) or public (curated public ones).","enum":["private","public"],"title":"Registry Name","type":"string"},"namespace":{"description":"Namespace of the module or provider. For private ones this is the organization name.","maxLength":100,"title":"Namespace","type":"string"},"name":{"description":"Module name, for example 'vpc'.","maxLength":100,"title":"Name","type":"string"},"provider":{"description":"Module provider in lowercase, for example 'aws'.","maxLength":60,"title":"Provider","type":"string"}},"required":["organization","registry_name","namespace","name","provider"],"title":"get_registry_moduleArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_module_versions":{"post":{"operationId":"list_module_versions","summary":"List the versions of a registry module with status and tags. Use for \"Which versions of the vpc module exist in my HCP T","description":"List the versions of a registry module with status and tags. Use for \"Which versions of the vpc module exist in my HCP Terraform private registry\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization":{"description":"HCP Terraform organization name, as returned by list_organizations in the HCP Terraform connector.","maxLength":100,"title":"Organization","type":"string"},"registry_name":{"description":"Which registry: private (modules and providers your organization published) or public (curated public ones).","enum":["private","public"],"title":"Registry Name","type":"string"},"namespace":{"description":"Namespace of the module or provider. For private ones this is the organization name.","maxLength":100,"title":"Namespace","type":"string"},"name":{"description":"Module name, for example 'vpc'.","maxLength":100,"title":"Name","type":"string"},"provider":{"description":"Module provider in lowercase, for example 'aws'.","maxLength":60,"title":"Provider","type":"string"}},"required":["organization","registry_name","namespace","name","provider"],"title":"list_module_versionsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_registry_providers":{"post":{"operationId":"list_registry_providers","summary":"List the providers in an organization's private registry (and any curated public providers) with namespace and registry.","description":"List the providers in an organization's private registry (and any curated public providers) with namespace and registry. Use for \"Which providers are in my HCP Terraform private registry\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization":{"description":"HCP Terraform organization name, as returned by list_organizations in the HCP Terraform connector.","maxLength":100,"title":"Organization","type":"string"},"search":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Search text matched against provider name and namespace.","title":"Search"},"registry":{"anyOf":[{"enum":["private","public"],"type":"string"},{"type":"null"}],"default":null,"description":"Only providers of this registry.","title":"Registry"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Items per page (1 to 100, default 20).","title":"Page Size"},"page_number":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page Number"}},"required":["organization"],"title":"list_registry_providersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_registry_provider":{"post":{"operationId":"get_registry_provider","summary":"Get one registry provider: name, namespace, registry and timestamps. Use for \"Show the aws provider in my HCP Terraform ","description":"Get one registry provider: name, namespace, registry and timestamps. Use for \"Show the aws provider in my HCP Terraform private registry\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization":{"description":"HCP Terraform organization name, as returned by list_organizations in the HCP Terraform connector.","maxLength":100,"title":"Organization","type":"string"},"registry_name":{"description":"Which registry: private (modules and providers your organization published) or public (curated public ones).","enum":["private","public"],"title":"Registry Name","type":"string"},"namespace":{"description":"Namespace of the module or provider. For private ones this is the organization name.","maxLength":100,"title":"Namespace","type":"string"},"name":{"description":"Provider name, for example 'aws'.","maxLength":60,"title":"Name","type":"string"}},"required":["organization","registry_name","namespace","name"],"title":"get_registry_providerArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_provider_versions":{"post":{"operationId":"list_provider_versions","summary":"List the versions of a registry provider with status and tags. Use for \"Which versions of the aws provider are in my HCP","description":"List the versions of a registry provider with status and tags. Use for \"Which versions of the aws provider are in my HCP Terraform private registry\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization":{"description":"HCP Terraform organization name, as returned by list_organizations in the HCP Terraform connector.","maxLength":100,"title":"Organization","type":"string"},"registry_name":{"description":"Which registry: private (modules and providers your organization published) or public (curated public ones).","enum":["private","public"],"title":"Registry Name","type":"string"},"namespace":{"description":"Namespace of the module or provider. For private ones this is the organization name.","maxLength":100,"title":"Namespace","type":"string"},"provider_name":{"description":"Provider name, for example 'aws'.","maxLength":60,"title":"Provider Name","type":"string"}},"required":["organization","registry_name","namespace","provider_name"],"title":"list_provider_versionsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}