Templates API

Templates management endpoints

Auto-generated from OpenAPI spec on 2025-10-02

GET /templates/deploy

GET deploy

🔒 Authentication Required: Bearer token

Parameters

Name	Type	Required	Description
`orgId`	query	Yes	Organization ID

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X GET https://api.syaala.com/templates/deploy \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json"

const response = await fetch('https://api.syaala.com/templates/deploy', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${process.env.SYAALA_API_KEY}`,
    'Content-Type': 'application/json'
  }
})
 
const data = await response.json()

import os
import requests
 
response = requests.get(
    'https://api.syaala.com/templates/deploy',
    headers={
        'Authorization': f'Bearer {os.environ["SYAALA_API_KEY"]}',
        'Content-Type': 'application/json'
    }
)
 
data = response.json()

POST /templates/deploy

POST deploy

🔒 Authentication Required: Bearer token

Request Body

{}

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X POST https://api.syaala.com/templates/deploy \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json" \\
  -d '{}'

const response = await fetch('https://api.syaala.com/templates/deploy', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.SYAALA_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({})
})
 
const data = await response.json()

import os
import requests
 
response = requests.post(
    'https://api.syaala.com/templates/deploy',
    headers={
        'Authorization': f'Bearer {os.environ["SYAALA_API_KEY"]}',
        'Content-Type': 'application/json'
    },
    json={}
)
 
data = response.json()

GET /templates/{id}/versions

GET versions

🔒 Authentication Required: Bearer token

Parameters

Name	Type	Required	Description
`id`	path	Yes	id identifier

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X GET https://api.syaala.com/templates/abc123/versions \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json"

const response = await fetch('https://api.syaala.com/templates/abc123/versions', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${process.env.SYAALA_API_KEY}`,
    'Content-Type': 'application/json'
  }
})
 
const data = await response.json()

import os
import requests
 
response = requests.get(
    'https://api.syaala.com/templates/abc123/versions',
    headers={
        'Authorization': f'Bearer {os.environ["SYAALA_API_KEY"]}',
        'Content-Type': 'application/json'
    }
)
 
data = response.json()

GET /templates/{id}/star

GET star

🔒 Authentication Required: Bearer token

Parameters

Name	Type	Required	Description
`id`	path	Yes	id identifier
`orgId`	query	Yes	Organization ID

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X GET https://api.syaala.com/templates/abc123/star \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json"

const response = await fetch('https://api.syaala.com/templates/abc123/star', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${process.env.SYAALA_API_KEY}`,
    'Content-Type': 'application/json'
  }
})
 
const data = await response.json()

import os
import requests
 
response = requests.get(
    'https://api.syaala.com/templates/abc123/star',
    headers={
        'Authorization': f'Bearer {os.environ["SYAALA_API_KEY"]}',
        'Content-Type': 'application/json'
    }
)
 
data = response.json()

POST /templates/{id}/star

POST star

🔒 Authentication Required: Bearer token

Parameters

Name	Type	Required	Description
`id`	path	Yes	id identifier

Request Body

{}

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X POST https://api.syaala.com/templates/abc123/star \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json" \\
  -d '{}'

const response = await fetch('https://api.syaala.com/templates/abc123/star', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.SYAALA_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({})
})
 
const data = await response.json()

import os
import requests
 
response = requests.post(
    'https://api.syaala.com/templates/abc123/star',
    headers={
        'Authorization': f'Bearer {os.environ["SYAALA_API_KEY"]}',
        'Content-Type': 'application/json'
    },
    json={}
)
 
data = response.json()

DELETE /templates/{id}/star

DELETE star

🔒 Authentication Required: Bearer token

Parameters

Name	Type	Required	Description
`id`	path	Yes	id identifier

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X DELETE https://api.syaala.com/templates/abc123/star \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json"

const response = await fetch('https://api.syaala.com/templates/abc123/star', {
  method: 'DELETE',
  headers: {
    'Authorization': `Bearer ${process.env.SYAALA_API_KEY}`,
    'Content-Type': 'application/json'
  }
})
 
const data = await response.json()

import os
import requests
 
response = requests.delete(
    'https://api.syaala.com/templates/abc123/star',
    headers={
        'Authorization': f'Bearer {os.environ["SYAALA_API_KEY"]}',
        'Content-Type': 'application/json'
    }
)
 
data = response.json()

POST /templates/{id}/new-version

POST new-version

🔒 Authentication Required: Bearer token

Parameters

Name	Type	Required	Description
`id`	path	Yes	id identifier

Request Body

{}

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X POST https://api.syaala.com/templates/abc123/new-version \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json" \\
  -d '{}'

const response = await fetch('https://api.syaala.com/templates/abc123/new-version', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.SYAALA_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({})
})
 
const data = await response.json()

import os
import requests
 
response = requests.post(
    'https://api.syaala.com/templates/abc123/new-version',
    headers={
        'Authorization': f'Bearer {os.environ["SYAALA_API_KEY"]}',
        'Content-Type': 'application/json'
    },
    json={}
)
 
data = response.json()

GET /templates/{id}/deploy

GET deploy

🔒 Authentication Required: Bearer token

Parameters

Name	Type	Required	Description
`id`	path	Yes	id identifier
`orgId`	query	Yes	Organization ID

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X GET https://api.syaala.com/templates/abc123/deploy \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json"

const response = await fetch('https://api.syaala.com/templates/abc123/deploy', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${process.env.SYAALA_API_KEY}`,
    'Content-Type': 'application/json'
  }
})
 
const data = await response.json()

import os
import requests
 
response = requests.get(
    'https://api.syaala.com/templates/abc123/deploy',
    headers={
        'Authorization': f'Bearer {os.environ["SYAALA_API_KEY"]}',
        'Content-Type': 'application/json'
    }
)
 
data = response.json()

POST /templates/{id}/deploy

POST deploy

🔒 Authentication Required: Bearer token

Parameters

Name	Type	Required	Description
`id`	path	Yes	id identifier

Request Body

{}

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X POST https://api.syaala.com/templates/abc123/deploy \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json" \\
  -d '{}'

const response = await fetch('https://api.syaala.com/templates/abc123/deploy', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.SYAALA_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({})
})
 
const data = await response.json()

import os
import requests
 
response = requests.post(
    'https://api.syaala.com/templates/abc123/deploy',
    headers={
        'Authorization': f'Bearer {os.environ["SYAALA_API_KEY"]}',
        'Content-Type': 'application/json'
    },
    json={}
)
 
data = response.json()

Team API SDKs & Client Libraries