v1

latestOpenAPI 3.1.02026-07-24239123562.1 KB

Protocols

Get single protocol

Returns a single protocol artifact matching the namespace, slug, and version

get/v1/artifacts/protocols/{namespace}/{slug}/{version}

Path parameters

namespacestring required

Artifact namespace. Should be common, private-, or client-

slugstring required

Artifact slug

versionstring required

Artifact version

Query parameters

include_prereleasesboolean

Include prerelease artifacts in search

Response

Successfully fetched ProtocolObject

namespacestring required

slugstring required

versionstring required

namestring nullable

descriptionstring nullable

createdAtstring date-time required

lastUpdatedAtstring date-time required

otherVersionsstring[]

type'protocol' required

protocolSchema'v2' | 'v3' | 'tfv1' required

triggerTypeFileboolean required

triggerTypeScheduledboolean required

Example response

{
  "type": "protocol",
  "namespace": "common",
  "slug": "akta",
  "version": "v1.2.18",
  "createdAt": "2023-02-16T15:15:34.269Z",
  "lastUpdatedAt": "2023-02-16T15:15:34.269Z",
  "name": "A demo protocol",
  "description": "The description for the demo protocol",
  "otherVersions": [
    "v1.2.18",
    "v1.2.17",
    "v1.1.0",
    "v0.0.10"
  ]
}