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.

PUT /o/{organisation_id}/projects/{project_id}/deploy

Deploy Project

cURL

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": {},
  "versionName": "<string>",
  "versionDescription": "<string>"
}
'

200

{
  "id": "<string>",
  "environments": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "publicUrl": "<string>",
      "config": {
        "deploymentSpec": {
          "replicas": 123,
          "autoscaling": {
            "maxReplicas": 123
          },
          "staticIP": true,
          "resources": {
            "limits": {
              "cpu": "<string>",
              "memory": "<string>"
            },
            "requests": {
              "cpu": "<string>",
              "memory": "<string>"
            }
          },
          "serviceAccountName": "<string>"
        }
      },
      "executionPool": "<string>",
      "files": [
        {
          "filename": "<string>",
          "content": "<string>"
        }
      ],
      "labels": {},
      "deployedVersion": {
        "id": "<string>",
        "name": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "labels": {}
      }
    }
  ],
  "name": "<string>",
  "currentFiles": {
    "files": [
      {
        "filename": "<string>",
        "content": "<string>"
      }
    ],
    "labels": {}
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "settings": {
    "acceptCodeChangesAutomatically": true,
    "testingMockWithAI": true,
    "planningChatVersion": "<string>",
    "chatStoredInDB": true
  },
  "metadata": {
    "sentimentHistory": [
      {
        "timestamp": "2023-11-07T05:31:56Z",
        "sentimentScore": 123,
        "messageId": "<string>"
      }
    ]
  },
  "dynamicVariablesSchema": {}
}

Authorizations

bearerTokencookie

Authorization · string · header · required

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

organisation_id · string<ulid> · required

project_id · string<ulid> · required

Query Parameters

project_env · string

Body

application/json

files · object[] · required

The files associated with the project.

Show child attributes

labels · object · required

The labels associated with the project. Labels are stored as key-value pairs. Only string-string values are allowed

versionName · string · required

The name of the version that will be created before deploying. If left empty a random name will be generated.

versionDescription · string

The description of the version that will be created before deploying.

Response

200

application/json

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.

id · string<ulid> · required

The unique identifier for the project.

environments · object[] · required

List of environments for the project.

Show child attributes

name · string · required

currentFiles · object · required

Show child attributes

createdAt · string<date-time> · required

updatedAt · string<date-time> · required

settings · object · required

ProjectSettings hold configuration for the project

Show child attributes

metadata · object · required

ProjectMetadata hold metadata for the project

Show child attributes

dynamicVariablesSchema · object

DynamicVariablesSchema is the JSON schema for the project's dynamic variables.