Update Projects Attributes Using PATCH

Modify the project attributes (Use projectId value "default" for accessing the default project). Property "makeRoot" will be only considered if "newParentProjectId" is null

Access Policy

Role	User Accounts	Service Accounts (Client Credentials Applications)
Organization Admin	✔️	✔️
Organization Owner	✔️	✔️
Project Admin	✔️	✔️

Request

URI

PATCH

https://{api_host}/csp/gateway/resource/api/v1/orgs/{orgId}/projects/{projectId}

COPY

Path Parameters

string

orgId

Required

Parent organization ID for the project

string

projectId

Required

Identifier of the project specified

Request Body

Configuration for the project

ModifyProjectRequest of type(s) application/json

Required

{
    "description": "string",
    "displayName": "string",
    "makeRoot": false,
    "newParentProjectId": "string",
    "vrn": "string"
}

string

description

Optional

Constraints: minLength: 0 maxLength: 255

Description of the project

string

displayName

Optional

Constraints: minLength: 0 maxLength: 255

Name of the project

boolean

makeRoot

Optional

Make this project a root project and remove references to the previous parent project

string

newParentProjectId

Optional

New parent project for this project if it needs to be moved

string

vrn

Optional

Project VRN

Authentication

This operation uses the following authentication methods.

token

Responses

200

Successful operation

Operation doesn't return any data structure

400

Invalid request body

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

401

Unauthorized

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

403

The user is forbidden to use the API

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

404

Not Found

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

409

The request could not be processed due to a conflict

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

429

The user has sent too many requests

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

500

Internal Server Error

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

Code Samples

COPY

                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}'

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Project Management Operations

GET

Get Projects In Organization Using GET

POST

Create Project In Organization Using POST

GET

Get Soft Deleted Projects In Organization Using GET

GET

Get Project Metadata Keys Using GET

POST

Search Projects By Metadata Using POST

DELETE

Delete Project From Organization Using DELETE

GET

Get Projects Details Using GET

PATCH

Update Projects Attributes Using PATCH

GET

Get Enabled Services For Project Using GET

DELETE

Delete Project Metadata Using DELETE

GET

Get Project Metadata Using GET

PATCH

Update Project Metadata Using PATCH

PUT

Set Project Metadata Using PUT

GET

Get Parent Projects Using GET

GET

Get Project Service Scopes Using GET

POST

Add Project Service Scopes Using POST

POST

Create Project In Organization V2 Using POST