Sign in

v1

latestOpenAPI 3.1.02026-07-24239123562.1 KB
Protocols

List all protocols for namespace/slug

Returns a list of all protocol artifacts given a namespace and slug

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

Path parameters

namespacestring required

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

slugstring required

Artifact slug

Query parameters

latest_onlyboolean

Only return the latest version of each artifact

include_prereleasesboolean

Include prerelease artifacts in search

Response

Successfully fetched ProtocolObject list

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"
    ]
  }
]