Skip to main content

Creating a project using the API

On project placements​

There are different ways to deploy a new project:

  1. When you have access to a server (which you will get for example when using the "Space Server" plan1), you can create a new project on that server. Any projects deployed on a server will utilize the same shared resource pool. Since you pay for the server, you can deploy as many projects as resource utilization allows, without additional costs.
  2. For the future, we reserve the option to offer the creation of stand-alone projects. These will be projects that are not part of a server, and will be deployed on a shared resource pool. You will pay for the resources used by the project, and you will be able to deploy as many projects as you want.

Creating a project…​

…on a server​

To create a project on an existing server, you will require that server’s ID. You can find all servers you have access to using the GET /v2/servers API endpoint.

To create a new project, send a POST request to the /v2/placementgroups/{serverId}/projects endpoint. The request body must contain a JSON object with the following properties:

  • description should contain a human-readable description of the project. This is a required value.

The response, when successful, will contain a JSON object with the following properties:

  • id is the ID of the newly created project.
info
For details please refer to the endpoint documentation for the following endpoint: project-create-project

…as a stand-alone project​

note

Creating stand-alone projects is not supported, as of yet.

Observing project readiness​

A newly created project will not be available immediately (however, it should be available within a few seconds). To check whether a project is ready, send a GET request to the /v2/projects/{projectID} endpoint. Among other properties, the response will contain an isReady property. This property will be true when the project is ready, and false otherwise.

info
For details please refer to the endpoint documentation for the following endpoint: project-get-project

Footnotes​

  1. https://www.mittwald.de/space-server ↩