Create API template.
ROLES: ENDPOINT_WRITE,ENDPOINT_ADMIN USER: true SERVICE ACCOUNT: true
curl --request POST \
--url https://api.revoengine.com/api/v1/endpoints \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"path": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', path: '<string>'})
};
fetch('https://api.revoengine.com/api/v1/endpoints', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.revoengine.com/api/v1/endpoints"
payload = {
"name": "<string>",
"path": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)Authorizations
Bearer JWT token or API Key (sk-*).
Body
Name.
Normalized path (e.g. /api/v1/users/:userId, /_/auth, or /users/@)
1024Method.
GET, POST, PUT, PATCH, DELETE Saved permission and current-user policy. Omit or clear to inherit the instance endpoint defaults.
Show child attributes
Show child attributes
{
"mode": "SERVICE_ACCOUNT",
"serviceAccountUserId": "00000000-0000-0000-0000-000000000000",
"currentUser": "CALLER"
}
Whether the endpoint is active immediately after creation. Set false for validate-before-activate rollouts.
Category.
Description.
Optional resource metadata. Values may use any JSON type. Maximum 16 KiB and 64 top-level keys. Top-level keys starting with "__" are reserved for backend use.
Component identifier.
Portable exact component revision identity. Omit it to follow the latest active revision. CUSTOM_NODEJS endpoints must omit it.
Endpoint execution timeout in seconds. The effective maximum is resolved at runtime from the current instance quota.
x >= 160
Endpoint runtime options. Custom low-code values live only under "input". For a new component-backed endpoint with a body, prefer popResult and set it to one exact visible output key for its raw value; use the complete visible result map only when explicitly required, or set noResult for an empty body. legacyResults is deprecated and must not be used for new endpoints.
Show child attributes
Show child attributes
Response
Job scheduled.
curl --request POST \
--url https://api.revoengine.com/api/v1/endpoints \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"path": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', path: '<string>'})
};
fetch('https://api.revoengine.com/api/v1/endpoints', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.revoengine.com/api/v1/endpoints"
payload = {
"name": "<string>",
"path": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)