OrkStageOrkStage
API referencemarketplace

POST /marketplace/listings

POST /marketplace/listings: OrkStage Control API v1 endpoint reference.

POST
/api/v1/marketplace/listings

Authorization

headerAuthorizationBearer <token>

Organization API key (scoped). Sessions use the cookie instead.

Header Parameters

x-orkstage-csrf?unknown

Cookie sessions: send "1" on POST/PATCH/PUT/DELETE. Not needed with an API key.

Request Body

application/json
  1. body
templateId*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
slug*string
Match^[a-z][a-z0-9-]{2,62}$
title*string
Length3 <= length <= 80
summary*string
Length10 <= length <= 240
description?string
Lengthlength <= 8000
Default""
categories*array<>
Items1 <= items <= 4
tags?array<>
Itemsitems <= 8
Default[]

Response Body

curl -X POST 'http://localhost:4300/api/v1/marketplace/listings' \  -H 'Content-Type: application/json' \  -d '{  "templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d",  "slug": "string",  "title": "string",  "summary": "stringstri",  "categories": [    "disaster-recovery"  ]}'
Empty
Edit on GitHub

GET /marketplace/listings GET

GET /marketplace/listings: OrkStage Control API v1 endpoint reference.

GET /marketplace/listings/{slug} GET

GET /marketplace/listings/{slug}: OrkStage Control API v1 endpoint reference.