API Reference
- POSTActivates a User on an Environment.
- GETList projects for organisation
- POSTCreate new project
- GETGet Project
- PUTUpdate Project
- DELDelete Project
- PUTSet the schema for the project variables
- PATCHPatch the schema for the project's dynamic variables
- GETGet Files
- PUTUpdate Files
- PUTDeploy Project
- GETGet Project Logs
- GETList project traces
- GETGet Trace
- POSTSuspend Project
- POST
curl --request GET \
--url https://platform.versori.com/api/v2/o/{organisation_id}/projects/{project_id} \
--header 'Authorization: Bearer <token>'{
"id": "<string>",
"environments": [
{
"id": "<string>",
"name": "<string>",
"status": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"publicUrl": "<string>",
"files": [
{
"filename": "<string>",
"content": "<string>"
}
],
"labels": {}
}
],
"name": "<string>",
"currentFiles": {
"files": [
{
"filename": "<string>",
"content": "<string>"
}
],
"labels": {}
},
"createdAt": "2023-11-07T05:31:56Z",
"settings": {
"acceptCodeChangesAutomatically": true
},
"dynamicVariablesSchema": {}
}Get Project
GetProject returns the files and configuration for the specified project ID. If one does not exist then a 404 will be returned.
curl --request GET \
--url https://platform.versori.com/api/v2/o/{organisation_id}/projects/{project_id} \
--header 'Authorization: Bearer <token>'{
"id": "<string>",
"environments": [
{
"id": "<string>",
"name": "<string>",
"status": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"publicUrl": "<string>",
"files": [
{
"filename": "<string>",
"content": "<string>"
}
],
"labels": {}
}
],
"name": "<string>",
"currentFiles": {
"files": [
{
"filename": "<string>",
"content": "<string>"
}
],
"labels": {}
},
"createdAt": "2023-11-07T05:31:56Z",
"settings": {
"acceptCodeChangesAutomatically": true
},
"dynamicVariablesSchema": {}
}Authorizations
Bearer token authentication used by the Versori Platform. External consumers must provide an API key, however internal consumers must provide a JWT id_token issued by our IdP.
Response
OK
The Project represents a deployable unit within our platform that includes both the functional components (files) and configuration. It serves as the backbone of custom or predefined functionalities, allowing organizations to create, update, and manage APIs and projects.
The unique identifier for the project.
List of environments for the project.
Show child attributes
Show child attributes
The unique identifier for the environment.
One of running|suspended|error|draft.
Labels is a map of key-value pairs that can be used to store arbitrary metadata about a resource. Keys must start with a letter and can only contain letters, numbers, and underscores. Values can be any string.
Show child attributes
Show child attributes
The labels associated with the project. Labels are stored as key-value pairs. Only string-string values are allowed
DynamicVariablesSchema is the JSON schema for the project's dynamic variables.