Update project (PATCH /v3/projects/{project_id})

Updates the specified project.

When a project is no longer used, disable it by changing the "enabled" setting to false.

However, before disabling a project, it is necessary to stop or delete the resources under it (If the resources are not stopped, they will remain billable).

Authentication (including retrieval of roles) will no longer be possible for a disabled project. If tokens for the disabled projects are used, they will become invalid.

Request headers

Content-type

Indicates the format of content defined in the MIME specification.

Specify application/json. (required)

Data type Cardinality
xsd:string 1..1

Accept

Indicates the accept format defined in the MIME specification.

Specify application/json. (optional)

Data type Cardinality
xsd:string 1..1

X-Auth-Token

Valid authentication token

Data type Cardinality
xsd:string 1..1

Request parameters

project_id

ID of the project (required)

Data type Cardinality Parent element Child element
xsd:string 1..1 None None

project

project object

Data type Cardinality Parent element Child element
Element 1.1 None description

enabled

name

description

Description of project

Refer to "Create project (POST /v3/projects)" for details on input values

Data type Cardinality Parent element Child element
xsd:string 0..1 project None

enabled

Enabled setting

Refer to "Create project (POST /v3/projects)" for details on input values

Data type Cardinality Parent element Child element
xsd:boolean 0..1 project None

name

Project name

Refer to "Create project (POST /v3/projects)" for details on input values

Data type Cardinality Parent element Child element
xsd:string 0..1 project None

Response headers

HTTP status code

Returns the HTTP status code of the request.

One of the following values will be returned.

200:
Normal completion
400:
Invalid access (invalid parameter, etc.)
401:
Authentication error
403:
Cannot access (no privileges)
404:
No applicable resources
409:
Data conflict occurred
500:
Unexpected error
501:
Has not been implemented
503:
Cannot use service
Data type Cardinality
int 1..1

Vary

By setting or changing the following header, notification is given that expressions can be requested in a different file format.

X-Auth-Token

Data type Cardinality
xsd:string 1..1

Content-Type

Indicates the format of content defined in the MIME specification.

application/json

Data type Cardinality
xsd:string 1..1

Content-Length

Indicates the length of an entity in bytes.

Data type Cardinality
int 1..1

Date

Indicates the date when the request was created.

Data type Cardinality
date 1..1

Response elements

project

project object

Data type Cardinality Parent element Child element
Element 1..1 None description

domain_id

enabled

extra

id

links

name

parent_id

description

Description of project

Data type Cardinality Parent element Child element
xsd:string 1..1 project None

domain_id

Domain ID

Data type Cardinality Parent element Child element
xsd:string 1..1 project None

enabled

Enabled setting

Data type Cardinality Parent element Child element
xsd:boolean 1..1 project None

extra

Extension information

Data type Cardinality Parent element Child element
xsd:string 1..1 project None

id

Project ID

Data type Cardinality Parent element Child element
xsd:string 1..1 project None

links

Link information of project

Data type Cardinality Parent element Child element
Element 1..1 project self

name

Project name

Data type Cardinality Parent element Child element
xsd:string 1..1 project None

parent_id

Parent ID

Data type Cardinality Parent element Child element
xsd:string 1..1 project None

Example of request


PATCH /v3/projects/--project-id--
X-Auth-Token: MIIIHgYJKoZIhvcNAQcCoIIIDzCCCAsCAQExC . . .
{
    "project": {
        "description": "my updated project",
        "enabled": true,
        "name": "myUpdatedProject"
    }
}       
     

Example of response


HTTP/1.1 200 OK
Vary: X-Auth-Token
Content-Type: application/json
Content-Length: 299
Date: Tue, 02 Sep 2014 06:07:40 GMT

{
    "project": {
        "description": "my updated project",
        "domain_id": "--domain-id--",
        "enabled": true,
        "extra": {},
        "id": "--project-id--",
        "links": {
            "self": "http://identity.jp-east-1.cloud.global.fujitsu.com/v3/projects/--project-id--"
        },
        "name": "myUpdatedProject",
        "parent_id": null
    }
}