Playgrounds
Create
Action Logs
Bitbucket Server
Catalog News Articles
Catalog Technologies
Code Repos
Comment Replies
Diagram Contents
Diagrams
Flows
Health
Landscape Search
Landscape Templates
Landscape Thumbnails
Model Connections
Model Objects
News
Organization Billing
Organization Icons
Organization Landscapes
Organizations
Organization Technologies
Organization User Invites
Organization Users
Playground Contents
Playground Shares
Share Link
Share Link Options
Support
User
User Notifications
User Goals
Version Reverts
Playgrounds
Create
POST
/
playgrounds
curl --request POST \
--url https://api.icepanel.io/v1/playgrounds \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"sharing": true
}'
{
"playground": {
"name": "<string>",
"sharing": true,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "user",
"createdById": "<string>",
"id": "<string>",
"slug": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "user",
"updatedById": "<string>",
"userIds": [
"<string>"
],
"users": {},
"version": 123
},
"playgroundContent": {
"connections": {},
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "user",
"createdById": "<string>",
"id": "<string>",
"objects": {},
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "user",
"updatedById": "<string>",
"version": 123
}
}
Headers
Body
application/json
Enable sharing of the playground to other users
Response
200
application/json
OK
Enable sharing of the playground to other users
Available options:
user
, api-key
, notification-key
, service
Random URL identifier for the playground
Available options:
user
, api-key
, notification-key
, service
Available options:
curved
, straight
, square
Available options:
top-left
, top-center
, top-right
, right-top
, right-middle
, right-bottom
, bottom-right
, bottom-center
, bottom-left
, left-bottom
, left-middle
, left-top
Available options:
top-left
, top-center
, top-right
, right-top
, right-middle
, right-bottom
, bottom-right
, bottom-center
, bottom-left
, left-bottom
, left-middle
, left-top
Available options:
user
, api-key
, notification-key
, service
Icon that only works on dark backgrounds
Example:
[
"/organizations/{organizationId}/dark/{catalogTechnologyId}.png",
"/dark/{catalogTechnologyId}.png"
]
Icon that only works on light backgrounds
Example:
[
"/organizations/{organizationId}/light/{catalogTechnologyId}.png",
"/light/{catalogTechnologyId}.png"
]
Available options:
actor
, area
, box
, store
Available options:
user
, api-key
, notification-key
, service
curl --request POST \
--url https://api.icepanel.io/v1/playgrounds \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"sharing": true
}'
{
"playground": {
"name": "<string>",
"sharing": true,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "user",
"createdById": "<string>",
"id": "<string>",
"slug": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "user",
"updatedById": "<string>",
"userIds": [
"<string>"
],
"users": {},
"version": 123
},
"playgroundContent": {
"connections": {},
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "user",
"createdById": "<string>",
"id": "<string>",
"objects": {},
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "user",
"updatedById": "<string>",
"version": 123
}
}