Hub Resource APIs
Retrieve the latest or a specific version of a Hub Task, Pipeline, or
StepAction. Detail responses contain the available versions, README, manifest,
and the URL of the raw YAML endpoint. Catalogs that are not visible from the
requested Namespace return 404 and do not disclose resource metadata.
/api/v1alpha1/{catalog}/{kind}/{name}
get Get the latest Hub resource version
Returns the latest indexed version of a Task, Pipeline, or StepAction, including its available versions, README, manifest, and raw-manifest URL. A catalog that is not visible from the Namespace is reported as 404 to avoid disclosing private catalog contents. This operation requires get permission on hub.tekton.dev/resources.
Parameters
catalog(in path):stringrequiredRepository or catalog name.
kind(in path): HubResourceKind requiredTekton resource kind.
name(in path):stringrequiredHub resource name.
namespace(in query):stringWorkspace Namespace used for authorization and catalog visibility filtering. It must be a DNS-1123 label. When omitted, the response uses the legacy unscoped catalog view. Generated
apiPathandmanifestURLvalues preserve this parameter.
Response
200HubResource: The requested Hub resource.400ErrorResponse: The Namespace, query parameter, path, or request body is invalid.401ErrorResponse: The Authorization header is missing or the Bearer token is invalid.403ErrorResponse: The authenticated caller is not allowed to access Hub resources in the Namespace.404ErrorResponse: The Namespace or resource does not exist, or the catalog is not visible from the Namespace. Hidden catalogs intentionally use the same status as missing resources.500ErrorResponse: Indexed README or manifest content could not be resolved.503ErrorResponse: The Hub index, authentication service, or Namespace lookup service is temporarily unavailable.
/api/v1alpha1/{catalog}/{kind}/{name}/{version}
get Get a specific Hub resource version
Returns one version of a Task, Pipeline, or StepAction, including its available versions, README, manifest, and raw-manifest URL. The version can use the original catalog value or its semantic-version-normalized equivalent. A catalog that is not visible from the Namespace is reported as 404. This operation requires get permission on hub.tekton.dev/resources.
Parameters
catalog(in path):stringrequiredRepository or catalog name.
kind(in path): HubResourceKind requiredTekton resource kind.
name(in path):stringrequiredHub resource name.
version(in path):stringrequiredOriginal or semantic-version-normalized resource version.
namespace(in query):stringWorkspace Namespace used for authorization and catalog visibility filtering. It must be a DNS-1123 label. When omitted, the response uses the legacy unscoped catalog view. Generated
apiPathandmanifestURLvalues preserve this parameter.
Response
200HubResource: The requested Hub resource.400ErrorResponse: The Namespace, query parameter, path, or request body is invalid.401ErrorResponse: The Authorization header is missing or the Bearer token is invalid.403ErrorResponse: The authenticated caller is not allowed to access Hub resources in the Namespace.404ErrorResponse: The Namespace or resource does not exist, or the catalog is not visible from the Namespace. Hidden catalogs intentionally use the same status as missing resources.500ErrorResponse: Indexed README or manifest content could not be resolved.503ErrorResponse: The Hub index, authentication service, or Namespace lookup service is temporarily unavailable.
/v1/resource/{catalog}/{kind}/{name}/{version}/yaml
get Get a raw Hub resource manifest
Returns the raw Tekton YAML referenced by spec.manifestURL in Hub resource responses. A catalog that is not visible from the Namespace is reported as 404. This operation requires get permission on hub.tekton.dev/resources.
Parameters
catalog(in path):stringrequiredRepository or catalog name.
kind(in path): HubResourceKind requiredTekton resource kind.
name(in path):stringrequiredHub resource name.
version(in path):stringrequiredOriginal or semantic-version-normalized resource version.
namespace(in query):stringWorkspace Namespace used for authorization and catalog visibility filtering. It must be a DNS-1123 label. When omitted, the response uses the legacy unscoped catalog view. Generated
apiPathandmanifestURLvalues preserve this parameter.
Response
200: The raw Tekton resource manifest.400ErrorResponse: The Namespace, query parameter, path, or request body is invalid.401ErrorResponse: The Authorization header is missing or the Bearer token is invalid.403ErrorResponse: The authenticated caller is not allowed to access Hub resources in the Namespace.404ErrorResponse: The Namespace or resource does not exist, or the catalog is not visible from the Namespace. Hidden catalogs intentionally use the same status as missing resources.500ErrorResponse: Indexed README or manifest content could not be resolved.503ErrorResponse: The Hub index, authentication service, or Namespace lookup service is temporarily unavailable.
HubResource
metadata: ObjectMetadataspec: HubResourceSpec
ObjectMetadata
name:stringHub resource name.
uid:stringDeterministic Artifact Hub Shim identifier.
labels:map[string]stringannotations:map[string]string
HubResourceSpec
version:stringSelected original catalog version.
available_versions:[]stringOriginal catalog versions sorted from oldest to newest.
apiPath:stringVersionless resource-detail path relative to
/api/v1alpha1/.tags:[]stringreadme:stringREADME Markdown. Empty when
includeContent=falseon a list request.platforms:[]stringmanifest:stringRaw Tekton YAML. Empty when
includeContent=falseon a list request.manifestURL:stringPath to the raw YAML endpoint for the selected version.
description:stringHuman-readable resource description.
raw:objectReserved compatibility field for additional resource data.
BadRequest
The Namespace, query parameter, path, or request body is invalid.
ErrorResponse
error:stringHuman-readable error message.
Unauthorized
The Authorization header is missing or the Bearer token is invalid.
Forbidden
The authenticated caller is not allowed to access Hub resources in the Namespace.
NotFound
The Namespace or resource does not exist, or the catalog is not visible from the Namespace. Hidden catalogs intentionally use the same status as missing resources.
InternalServerError
Indexed README or manifest content could not be resolved.
ServiceUnavailable
The Hub index, authentication service, or Namespace lookup service is temporarily unavailable.