API Reference
- GETLists the systems for the organisation.
- POSTCreate a new system.
- GETGet a system by ID.
- PUTUpdate system.
- DELDelete a system by ID.
- POSTLink system actions to project.
- POSTLink system triggers to project.
- GETList actions for a system.
- POSTCreate new actions for a system.
- GETGet an action for a system.
- PUTUpdate an action for a system.
- DELDelete an action for a system.
- GETList triggers for a system.
- POSTCreate new triggers for a system.
- PUTAdds or updates an auth scheme for the system.
- DELDeletes an auth scheme for the system.
- GETList project environment connection templates
- POSTCreate a new connection template
- PUTRemove a system from a project environment
- DELRemove a connection template
curl --request PUT \
--url https://platform.versori.com/api/v2/o/{organisation_id}/systems/{system_id}/actions/{action_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"systemId": "<string>",
"type": "http",
"name": "<string>",
"method": "GET",
"path": "<string>",
"parameters": [
{
"name": "<string>",
"in": "path",
"required": true,
"type": "string",
"default": "<string>"
}
],
"contentType": "<string>",
"summary": "<string>",
"description": "<string>",
"graphqlQuery": "<string>",
"request": "<string>",
"response": "<string>"
}
'{
"id": "<string>",
"systemId": "<string>",
"type": "http",
"name": "<string>",
"method": "GET",
"path": "<string>",
"parameters": [
{
"name": "<string>",
"in": "path",
"required": true,
"type": "string",
"default": "<string>"
}
],
"contentType": "<string>",
"summary": "<string>",
"description": "<string>",
"graphqlQuery": "<string>",
"request": "<string>",
"response": "<string>"
}Update an action for a system.
UpdateSystemAction updates a single action for the given system.
curl --request PUT \
--url https://platform.versori.com/api/v2/o/{organisation_id}/systems/{system_id}/actions/{action_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"systemId": "<string>",
"type": "http",
"name": "<string>",
"method": "GET",
"path": "<string>",
"parameters": [
{
"name": "<string>",
"in": "path",
"required": true,
"type": "string",
"default": "<string>"
}
],
"contentType": "<string>",
"summary": "<string>",
"description": "<string>",
"graphqlQuery": "<string>",
"request": "<string>",
"response": "<string>"
}
'{
"id": "<string>",
"systemId": "<string>",
"type": "http",
"name": "<string>",
"method": "GET",
"path": "<string>",
"parameters": [
{
"name": "<string>",
"in": "path",
"required": true,
"type": "string",
"default": "<string>"
}
],
"contentType": "<string>",
"summary": "<string>",
"description": "<string>",
"graphqlQuery": "<string>",
"request": "<string>",
"response": "<string>"
}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.
Path Parameters
Body
http, graphql GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS Path is the path of the action, which may contain templated values in curly braces.
For example, /users/{userId}. The path should be the full path relative to the base URL of the system,
the base URL containing everything before (and including) the top-level domain (.com, .gov, .org etc).
Parameters is a list of parameters which are used to configure the action. These may be
used to set values in the path, query string or headers of the request. Note that when creating an action,
if the path contains templated values in curly braces, these will automatically be converted into
parameters of type path with the name of the parameter being the name of the templated value.
Show child attributes
Show child attributes
ContentType is the content type that this action expects to receive in the request body if any, and the content type of the response body if any. If this field is left blank, then "application/json" is assumed.
GraphQLQuery is the GraphQL query to execute for the action. This is only used if the action type is graphql.
Request is the request body of the action. This is only used if the action type is http.
Response is the response body of the action. This is only used if the action type is http.
Response
OK
http, graphql GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS Path is the path of the action, which may contain templated values in curly braces.
For example, /users/{userId}. The path should be the full path relative to the base URL of the system,
the base URL containing everything before (and including) the top-level domain (.com, .gov, .org etc).
Parameters is a list of parameters which are used to configure the action. These may be
used to set values in the path, query string or headers of the request. Note that when creating an action,
if the path contains templated values in curly braces, these will automatically be converted into
parameters of type path with the name of the parameter being the name of the templated value.
Show child attributes
Show child attributes
ContentType is the content type that this action expects to receive in the request body if any, and the content type of the response body if any. If this field is left blank, then "application/json" is assumed.
GraphQLQuery is the GraphQL query to execute for the action. This is only used if the action type is graphql.
Request is the request body of the action. This is only used if the action type is http.
Response is the response body of the action. This is only used if the action type is http.