Create a new playground snippet

POST

public

create-new-playground-snippet

curl --request POST \
  --url https://backend.codedamn.com/api/public/create-new-playground-snippet \
  --header 'Content-Type: application/json' \
  --header 'FERMION-API-KEY: <api-key>' \
  --data '
{
  "data": [
    {
      "data": {
        "bootParams": {
          "source": "git-repo",
          "gitRepoUrl": "<string>",
          "gitBranch": "<string>"
        }
      }
    }
  ]
}
'

[
  {
    "output": {
      "status": "ok",
      "data": {
        "playgroundSnippetId": "<string>"
      }
    }
  }
]

Authorizations

FERMION-API-KEY

string

header

required

Body

application/json

API Request Body

data

object[]

required

Show child attributes

data.data

object

required

Show child attributes

data.data.bootParams

object

required

Option 1
Option 2

Show child attributes

data.data.bootParams.source

enum<string>

required

Source type for creating playground snippet from a Git repository

Available options:

git-repo

data.data.bootParams.gitRepoUrl

string<uri>

required

URL of the Git repository to clone for the playground snippet

data.data.bootParams.gitBranch

string

Git branch to checkout from the repository (defaults to main/master)

Response

200 - application/json

API Response Body

output

object

required

Option 1
Option 2

Show child attributes

output.status

enum<string>

required

Available options:

ok

output.data

object

required

Show child attributes

output.data.playgroundSnippetId

string

required

Unique identifier for the created playground snippet. Use this to attach to the sandbox now and in future

Start playground session Start a new playground session for a playground snippet Authentication with the "FERMION-API-KEY" header is required to use this endpoint. Rate limit: Maximum 80 requests in a window of 1m.

⌘I

Create a new playground snippet

curl --request POST \
  --url https://backend.codedamn.com/api/public/create-new-playground-snippet \
  --header 'Content-Type: application/json' \
  --header 'FERMION-API-KEY: <api-key>' \
  --data '
{
  "data": [
    {
      "data": {
        "bootParams": {
          "source": "git-repo",
          "gitRepoUrl": "<string>",
          "gitBranch": "<string>"
        }
      }
    }
  ]
}
'

[
  {
    "output": {
      "status": "ok",
      "data": {
        "playgroundSnippetId": "<string>"
      }
    }
  }
]

Using API

Endpoints

Authorizations

Body

Response