#StepAction APIs

List the Hub StepActions visible from a Workspace Namespace or retrieve a requested set of StepActions in one batch. Text search is performed by clients over the list response; this endpoint does not accept a server-side search expression.

#/api/v1alpha1/stepactions

#get List Hub StepActions

Returns the StepActions visible from the requested Namespace. Visibility filtering happens before pagination. The API does not provide a server-side text-search parameter; clients can search or filter the returned list. This operation requires list permission on hub.tekton.dev/resources.

#Parameters

• namespace (in query): string

  Workspace 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 apiPath and manifestURL values preserve this parameter.

• includeContent (in query): boolean

  Whether list items include README and manifest content. Detail and batch responses always include content.

• offset (in query): integer

  Zero-based offset applied after visibility filtering.

• limit (in query): integer

  Maximum number of items to return. When supplied, the server caps it at config.maxBatchQuerySize, which defaults to 200. When omitted, all items after offset are returned.

#Response

• 200 HubResourceList: The requested Hub resources.
• 400 ErrorResponse: The Namespace, query parameter, path, or request body is invalid.
• 401 ErrorResponse: The Authorization header is missing or the Bearer token is invalid.
• 403 ErrorResponse: The authenticated caller is not allowed to access Hub resources in the Namespace.
• 404 ErrorResponse: 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.
• 500 ErrorResponse: Indexed README or manifest content could not be resolved.
• 503 ErrorResponse: The Hub index, authentication service, or Namespace lookup service is temporarily unavailable.

#post Batch-query Hub StepActions

Returns the requested StepActions in request order. The request is atomic: if any resource is missing or not visible from the Namespace, the entire request returns 404. The default deployment accepts at most 200 entries and limits the JSON body to 1 MiB. This operation requires list permission on hub.tekton.dev/resources.

#Parameters

• namespace (in query): string

  Workspace 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 apiPath and manifestURL values preserve this parameter.

#Request Body

StepActionBatchRequestrequired

#Response

• 200 HubResourceList: The requested Hub resources.
• 400 ErrorResponse: The Namespace, query parameter, path, or request body is invalid.
• 401 ErrorResponse: The Authorization header is missing or the Bearer token is invalid.
• 403 ErrorResponse: The authenticated caller is not allowed to access Hub resources in the Namespace.
• 404 ErrorResponse: 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.
• 413 ErrorResponse: The batch request body exceeds 1 MiB.
• 500 ErrorResponse: Indexed README or manifest content could not be resolved.
• 503 ErrorResponse: The Hub index, authentication service, or Namespace lookup service is temporarily unavailable.

#HubResourceList

• metadata: ListMetadata
• items: []HubResource

#ListMetadata

• resourceVersion: string

  Reserved for Kubernetes list compatibility; normally empty.

#HubResource

• metadata: ObjectMetadata
• spec: HubResourceSpec

#ObjectMetadata

• name: string

  Hub resource name.

• uid: string

  Deterministic Artifact Hub Shim identifier.

• labels: map[string]string
• annotations: map[string]string

#HubResourceSpec

• version: string

  Selected original catalog version.

• available_versions: []string

  Original catalog versions sorted from oldest to newest.

• apiPath: string

  Versionless resource-detail path relative to /api/v1alpha1/.

• tags: []string
• readme: string

  README Markdown. Empty when includeContent=false on a list request.

• platforms: []string
• manifest: string

  Raw Tekton YAML. Empty when includeContent=false on a list request.

• manifestURL: string

  Path to the raw YAML endpoint for the selected version.

• description: string

  Human-readable resource description.

• raw: object

  Reserved compatibility field for additional resource data.

#BadRequest

The Namespace, query parameter, path, or request body is invalid.

#ErrorResponse

• error: string

  Human-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.

#StepActionBatchRequest

Metadata for the StepActions to retrieve.

#HubResourceBatchRequest

Batch lookup entries. The configured maximum can differ from the documented default of 200.

#HubResourceLookup

• catalog: string

  Repository or catalog name.

• kind: string
• name: string

  Hub resource name.

• version: string

  Optional version. When omitted, the latest version is returned.

#HubResourceKind

#PayloadTooLarge

The batch request body exceeds 1 MiB.