Help Center/ EventGrid/ API Reference/ Appendix/ Obtaining a Project ID
Updated on 2023-05-24 GMT+08:00

Obtaining a Project ID

Scenario

A project ID is required for some URLs when an API is called. Obtain a project ID using either of the following methods:

Obtaining a Project ID by Calling an API

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

The API used to obtain 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 on API calling authentication, see Authentication.

In the following example, id indicates the project ID.

{
    "projects": [
        {
            "domain_id": "65382450e8f64ac0870cd180d14e684b",
            "is_domain": false,
            "parent_id": "65382450e8f64ac0870cd180d14e684b",
            "name": "xxx-xxx-xxx",
            "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 on the Console

A project ID is required for some URLs when an API is called. You can obtain a project ID on the console.

The following procedure describes how to obtain a project ID:

  1. Log in to the management console.
  2. Hover the pointer over the username in the upper right corner and choose My Credentials from the drop-down list.

    On the API Credentials page, view the project ID in the project list.

    Figure 1 Viewing a project ID