Get Project
Retrieves a project by id.
The id of the project.
Optional permissions that, if granted to the users, allow them access to the proper set of projects. If the user actually has any of those permissions, the 'excludeViewer' parameter has no effect.
The version of the API in yyyy-MM-dd format. For versioning information refer to /project-service/api/about.
'Success' with the Project
{
"id": "string",
"name": "my-name",
"description": "my-description",
"orgId": "string",
"administrators": [
{
"email": "[email protected]",
"type": "user"
}
],
"members": [
{
"email": "[email protected]",
"type": "user"
}
],
"viewers": [
{
"email": "[email protected]",
"type": "user"
}
],
"supervisors": [
{
"email": "[email protected]",
"type": "user"
}
],
"users": [
{
"email": "[email protected]",
"type": "user"
}
],
"auditors": [
{
"email": "[email protected]",
"type": "user"
}
],
"advancedUsers": [
{
"email": "[email protected]",
"type": "user"
}
],
"constraints": {
"network": {
"conditions": [
{
"type": "TAG",
"enforcement": "HARD",
"occurrence": "MUST_OCCUR",
"expression": {
"key": "key",
"value": "value"
}
}
]
}
},
"properties": {
"myproperty": "enforcement",
"__projectPlacementPolicy": "SPREAD",
"__namingTemplate": "my-resource-template",
"__allowTerraformCloudzoneMapping": "true"
},
"cost": {
"cost": "number",
"costSyncTime": "2011-12-03T10:15:30Z",
"costUnit": "USD",
"message": "string",
"code": "string"
},
"operationTimeout": 0,
"sharedResources": false
}Id of the project.
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
The id of the org this project belongs to.
List of administrator users associated with the project. Only administrators can manage project's configuration.
List of member users associated with the project.
List of viewer users associated with the project.
List of supervisor users associated with the project.
List of users associated with the project.
List of auditor users associated with the project.
List of advanced user users associated with the project.
List of constraints of the project.
List of properties of the project, to be applied to any resource provisioned within the project.
The property with key __projectPlacementPolicy shows what is the placement policy for the resources provisioned in this project, which can be 1 of only 2 possible values DEFAULT or SPREAD. If not specified, it is set as DEFAULT.
The property with key __namingTemplate specifies a custom naming template for resources provisioned in this project.
The property with key __allowTerraformCloudzoneMapping shows if the project allows Terraform cloudzone mapping. It can be set to either true or false. By default, it is set to false.
A representation of a project cost.
The timeout that should be used for Blueprint operations and Provisioning tasks. The timeout is in seconds.
Specifies whether the resources in this projects are shared or not. Only allowed for classic tenants.
Forbidden, the user lacks permissions
'Not found' if no project with the provided id
curl -H 'Authorization: <value>' https://{api_host}/project-service/api/projects/{id}