Stay organized with collections
Save and categorize content based on your preferences.
The Resource Manager API uses Kubernetes custom resources and relies on the
Kubernetes Resource Model (KRM) for provisioning and administration of
organization and project resources. It is used to manage the lifecycle of
Google Distributed Cloud (GDC) air-gapped appliance projects, such as installing, upgrading, and
uninstalling.
To use the Resource Manager API, we recommend that you use the
GDC console and gdcloud CLI. If your application needs to
use your own libraries to call this API, use the following example and the
full API definition to build your
requests.
Service endpoint and discovery document
The API endpoint for the Resource Manager API is
https://MANAGEMENT_API_SERVER_ENDPOINT/apis/resourcemanager.gdc.goog/v1
where MANAGEMENT_API_SERVER_ENDPOINT is the endpoint of the
Management API server.
The Resource Manager View API follows a similar convention for its API endpoint:
https://MANAGEMENT_API_SERVER_ENDPOINT/apis/resourcemanagerview.gdc.goog/v1.
Using the kubectl proxy command, you can access the API endpoint URLs in your
browser or with a tool such as curl to get the discovery document for the
Resource Manager API. The kubectl proxy command opens up a proxy to the
Kubernetes API server on your local machine. Once that command is running, you
can access the document at the following URL:
http://127.0.0.1:8001/apis/resourcemanager.gdc.goog/v1.
Example Project resource
The following is an example of a Project object configured as a
GDC project resource. As a user of the Resource Manager
API, creating a project through the GDC console generates the
Project object by default. You must only modify it to reflect the project
state you want.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-03 UTC."],[[["\u003cp\u003eThe Resource Manager API utilizes Kubernetes custom resources and the Kubernetes Resource Model (KRM) for managing organization and project resources.\u003c/p\u003e\n"],["\u003cp\u003eIt primarily manages the lifecycle of Google Distributed Cloud (GDC) air-gapped appliance projects, including installation, upgrades, and uninstallation.\u003c/p\u003e\n"],["\u003cp\u003eThe recommended methods for interacting with the API are the GDC console and the gdcloud CLI, although custom library integration is supported.\u003c/p\u003e\n"],["\u003cp\u003eThe API endpoint for the Resource Manager API is \u003ccode\u003ehttps://GDCH_API_SERVER_ENDPOINT/apis/resourcemanager.gdc.goog/v1\u003c/code\u003e, and the Resource Manager View API follows a similar structure.\u003c/p\u003e\n"],["\u003cp\u003eAccessing the API endpoint URLs and the discovery document can be done using the \u003ccode\u003ekubectl proxy\u003c/code\u003e command, which provides a proxy to the Kubernetes API server.\u003c/p\u003e\n"]]],[],null,["# Resource Manager API overview\n\nThe Resource Manager API uses Kubernetes custom resources and relies on the\nKubernetes Resource Model (KRM) for provisioning and administration of\norganization and project resources. It is used to manage the lifecycle of\nGoogle Distributed Cloud (GDC) air-gapped appliance projects, such as installing, upgrading, and\nuninstalling.\n\nTo use the Resource Manager API, we recommend that you use the\nGDC console and gdcloud CLI. If your application needs to\nuse your own libraries to call this API, use the following example and the\n[full API definition](/distributed-cloud/hosted/docs/latest/appliance/apis/service/resourcemanager/v1/resourcemanager-v1) to build your\nrequests.\n\nService endpoint and discovery document\n---------------------------------------\n\nThe API endpoint for the Resource Manager API is\n`https://`\u003cvar translate=\"no\"\u003eMANAGEMENT_API_SERVER_ENDPOINT\u003c/var\u003e`/apis/resourcemanager.gdc.goog/v1`\nwhere \u003cvar translate=\"no\"\u003eMANAGEMENT_API_SERVER_ENDPOINT\u003c/var\u003e is the endpoint of the\nManagement API server.\n\nThe Resource Manager View API follows a similar convention for its API endpoint:\n`https://`\u003cvar translate=\"no\"\u003eMANAGEMENT_API_SERVER_ENDPOINT\u003c/var\u003e`/apis/resourcemanagerview.gdc.goog/v1`.\n\nUsing the `kubectl proxy` command, you can access the API endpoint URLs in your\nbrowser or with a tool such as `curl` to get the discovery document for the\nResource Manager API. The `kubectl proxy` command opens up a proxy to the\nKubernetes API server on your local machine. Once that command is running, you\ncan access the document at the following URL:\n`http://127.0.0.1:8001/apis/resourcemanager.gdc.goog/v1`.\n\nExample Project resource\n------------------------\n\nThe following is an example of a `Project` object configured as a\nGDC project resource. As a user of the Resource Manager\nAPI, creating a project through the GDC console generates the\n`Project` object by default. You must only modify it to reflect the project\nstate you want. \n\n apiVersion: resourcemanager.gdc.goog/v1\n kind: Project\n name: test-project\n namespace: test-namespace"]]
