Help Center/ Workspace/ API Reference/ Appendix/ Obtaining a Project ID
Updated on 2024-01-10 GMT+08:00

Obtaining a Project ID

Obtaining a Project ID by Calling an API

You can also obtain the project ID by calling the API used to query project information based on the specified criteria.

The API for obtaining a project ID is GET https://{Endpoint}/v3/projects, where {Endpoint} indicates the IAM endpoint. You can obtain the IAM endpoint from Regions and Endpoints. For details about API authentication, see Authentication.

The following is an example response. id indicates a project ID.

{ 
    "projects": [ 
        { 
            "domain_id": "65382450e8f64ac0870cd180d14e684b", 
            "is_domain": false, 
            "parent_id": "65382450e8f64ac0870cd180d14e684b", 
            "name": "project_name", 
            "description": "", 
            "links": { 
                "next": null, 
                "previous": null, 
                "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" 
            }, 
            "id": "a4a5d4098fb4474fa22cd05f897d6b99", 
            "enabled": true 
        } 
    ], 
    "links": { 
        "next": null, 
        "previous": null, 
        "self": "https://www.example.com/v3/projects" 
    } 
}

Obtaining a Project ID from the Console

A project ID needs to be specified in the URLs of some APIs. Therefore, you need to obtain a project ID before calling such APIs. Perform the following steps to obtain a project ID:

  1. Log in to Workspace Console.
  2. Hover over the username and choose My Credentials from the drop-down list.

    On the displayed API Credentials page, view project IDs in the project list.

    Figure 1 Viewing a project ID