Create Project

Create Project

Create project

Request
URI
POST
https://{api_host}/iaas/api/projects
COPY
Query Parameters
string
apiVersion
Optional

The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /iaas/api/about


Request Body

Project Specification instance

ProjectSpecification of type(s) application/json
Required
{
    "name": "string",
    "description": "string",
    "administrators": [
        {
            "email": "[email protected]"
        }
    ],
    "members": [
        {
            "email": "[email protected]"
        }
    ],
    "zoneAssignmentConfigurations": [
        {
            "zoneId": "77ee1",
            "priority": 1,
            "maxNumberInstances": 50
        }
    ],
    "operationTimeout": 30,
    "machineNamingTemplate": "${project.name}-test-${####}",
    "sharedResources": true
}
string
name
Required

A human-friendly name used as an identifier in APIs that support this option.

string
description
Optional

A human-friendly description.

array of User
administrators
Optional

List of administrator users associated with the project. Only administrators can manage project's configuration.

array of User
members
Optional

List of member users associated with the project.

zoneAssignmentConfigurations
Optional

List of configurations for zone assignment to a project.

object
constraints
Optional

List of storage, network and extensibility constraints to be applied when provisioning through this project.

integer As int64 As int64
operationTimeout
Optional

The timeout that should be used for Blueprint operations and Provisioning tasks. The timeout is in seconds

string
machineNamingTemplate
Optional

The naming template to be used for machines provisioned in this project

boolean
sharedResources
Optional

Specifies whether the resources in this projects are shared or not. If not set default will be used.

Responses
201

successful operation

Returns Project of type(s) application/json
{
    "id": "9e49",
    "createdAt": "2012-09-27",
    "updatedAt": "2012-09-27",
    "owner": "[email protected]",
    "organizationId": "deprecated",
    "orgId": "9e49",
    "name": "my-name",
    "description": "my-description",
    "administrators": [
        {
            "email": "[email protected]"
        }
    ],
    "members": [
        {
            "email": "[email protected]"
        }
    ],
    "zones": [
        {
            "zoneId": "77ee1",
            "priority": 1,
            "maxNumberInstances": 50
        }
    ],
    "operationTimeout": 0,
    "machineNamingTemplate": "${project.name}-test-${####}",
    "sharedResources": false
}
string
id
Required

The id of this resource instance

string
createdAt
Optional

Date when the entity was created. The date is in ISO 6801 and UTC.

string
updatedAt
Optional

Date when the entity was last updated. The date is ISO 8601 and UTC.

string
owner
Optional

Email of the user that owns the entity.

string
organizationId
Optional

This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.

string
orgId
Optional

The id of the organization this entity belongs to.

object
_links
Required

HATEOAS of the entity

string
name
Optional

A human-friendly name used as an identifier in APIs that support this option.

string
description
Optional

A human-friendly description.

array of User
administrators
Optional

List of administrator users associated with the project. Only administrators can manage project's configuration.

array of User
members
Optional

List of member users associated with the project.

zones
Optional

List of Cloud Zones assigned to this project. You can limit deployment to a single region or allow multi-region placement by adding more than one cloud zone to a project. A cloud zone lists available resources. Use tags on resources to control workload placement.

object
constraints
Optional

List of storage, network and extensibility constraints to be applied when provisioning through this project.

integer As int64 As int64
operationTimeout
Optional

The timeout that should be used for Blueprint operations and Provisioning tasks. The timeout is in seconds

string
machineNamingTemplate
Optional

The naming template to be used for machines provisioned in this project

boolean
sharedResources
Optional

Specifies whether the resources in this projects are shared or not.


400

Invalid Request - bad data

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure