Stacks

List stack directory entries

GET /api/v1/stacks

Parameters

Name	In	Type	Required	Description
`organisationId`	query	string	No	—
`search`	query	string	No	—
`categoryId`	query	string	No	—
`subcategoryId`	query	string	No	—
`limit`	query	integer	No	—

Example request

curl -X GET \
"https://api.example.com/api/v1/stacks?organisationId=<organisationId>&search=<search>&categoryId=<categoryId>&subcategoryId=<subcategoryId>&limit=<limit>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Example response

Status: 200

{
  "data": [
    {
      "_id": "string",
      "name": "string",
      "website": "string",
      "docs": "string",
      "description": "string",
      "userId": "string",
      "organisationId": "string",
      "createdAt": 0,
      "updatedAt": 0
    }
  ]
}

Response body type

{ data: Stack[] }

Create stack directory entry

POST /api/v1/stacks

Example request

curl -X POST \
"https://api.example.com/api/v1/stacks" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"
-d '{"name":"string","website":"string","docs":"string","description":"string","organisationId":"string","categoryIds":["string"],"subcategoryIds":["string"],"containerIds":["string"]}'

Response body type

—

Get stack directory entry

GET /api/v1/stacks/{id}

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	Path parameter.

Example request

curl -X GET \
"https://api.example.com/api/v1/stacks/<id>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Example response

Status: 200

{
  "data": {
    "_id": "string",
    "name": "string",
    "website": "string",
    "docs": "string",
    "description": "string",
    "userId": "string",
    "organisationId": "string",
    "createdAt": 0,
    "updatedAt": 0
  }
}

Response body type

{ data: Stack }

Update stack directory entry

PATCH /api/v1/stacks/{id}

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	Path parameter.

Example request

curl -X PATCH \
"https://api.example.com/api/v1/stacks/<id>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"
-d '{"name":"string","website":"string","docs":"string","description":"string","containerIds":["string"]}'

Response body type

—

Delete stack directory entry

DELETE /api/v1/stacks/{id}

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	Path parameter.

Example request

curl -X DELETE \
"https://api.example.com/api/v1/stacks/<id>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Response body type

—