Activations
Connections
Projects
- POSTActivates a User on an Environment.
- POSTCreate new project
- DELDelete Project
- PUTDeploy Project
- GETGet Files
- GETGet Project Logs
- GETGet Project
- GETGet Trace
- GETList project traces
- GETList projects for organisation
- PATCHPatch the schema for the project's dynamic variables
- PUTSet the schema for the project variables
- POSTSuspend Project
- PUTUpdate Files
- PUTUpdate Project
Systems
- POSTAdd a system to a project environment
- PUTAdds or updates an auth scheme for the system.
- POSTCreate a new connection template
- POSTCreate a new system.
- DELDeletes an auth scheme for the system.
- GETList project environment connection templates
- GETList the systems linked to the project environment.
- GETLists the systems for the organisation.
- DELRemove a connection template
- PUTRemove a system from a project environment
- DELRemove a system from a project environment
- PUTUpdate system.
curl --request PUT \
--url https://platform.versori.com/api/v2/o/{organisation_id}/projects/{project_id}/deploy \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"files": [
{
"filename": "<string>",
"content": "<string>"
}
],
"labels": {}
}
'{
"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": {}
}Deploy Project
DeployProject deploys the project to the specified environment using the current files. It processes the files to deploy a new version of the project and updates the underlying connector to integrate the new API.
curl --request PUT \
--url https://platform.versori.com/api/v2/o/{organisation_id}/projects/{project_id}/deploy \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"files": [
{
"filename": "<string>",
"content": "<string>"
}
],
"labels": {}
}
'{
"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.
Body
The labels associated with the project. Labels are stored as key-value pairs. Only string-string values are allowed
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.