Stay organized with collections
Save and categorize content based on your preferences.
The IP Address Management (IPAM) API uses Kubernetes custom resources and relies
on the Kubernetes Resource Model (KRM). It manages IP address allocation across
a Google Distributed Cloud (GDC) air-gapped appliance deployment.
To use the IPAM API, we recommend that you use the gdcloud CLI, or
call the API directly using the kubectl CLI. If your application needs to use
your own libraries to call this API, use the following examples and the
full API definition to build your
requests.
Service endpoint and discovery document
The following URL is the API endpoint for the IPAM KRM API:
Replace MANAGEMENT_API_SERVER_ENDPOINT with the endpoint of the
Management API server.
Using the kubectl proxy command, you can access that URL in your browser or
with a tool such as curl to get the discovery document for the IPAM API.
The kubectl proxy command opens up a proxy to the Kubernetes API server on
your local machine. After that command is running, you can access the document at
the following URL: http://127.0.0.1:8001/apis/ipam.gdc.goog/v1.
[[["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-04 UTC."],[],[],null,["# IP Address Management API overview\n\nThe IP Address Management (IPAM) API uses Kubernetes custom resources and relies\non the Kubernetes Resource Model (KRM). It manages IP address allocation across\na Google Distributed Cloud (GDC) air-gapped appliance deployment.\n\nTo use the IPAM API, we recommend that you use the gdcloud CLI, or\ncall the API directly using the `kubectl` CLI. If your application needs to use\nyour own libraries to call this API, use the following examples and the\n[full API definition](/distributed-cloud/hosted/docs/latest/appliance/apis/service/ipam/v1/ipam-v1) to build your\nrequests.\n\nService endpoint and discovery document\n---------------------------------------\n\nThe following URL is the API endpoint for the IPAM KRM API: \n\n https://\u003cvar translate=\"no\"\u003eMANAGEMENT_API_SERVER_ENDPOINT\u003c/var\u003e/apis/ipam.gdc.goog/v1\n\nReplace \u003cvar translate=\"no\"\u003eMANAGEMENT_API_SERVER_ENDPOINT\u003c/var\u003e with the endpoint of the\nManagement API server.\n\nUsing the `kubectl proxy` command, you can access that URL in your browser or\nwith a tool such as `curl` to get the discovery document for the IPAM API.\nThe `kubectl proxy` command opens up a proxy to the Kubernetes API server on\nyour local machine. After that command is running, you can access the document at\nthe following URL: `http://127.0.0.1:8001/apis/ipam.gdc.goog/v1`.\n\nExample custom resources\n------------------------\n\nThe following is an example of a `Subnet` object: \n\n apiVersion: ipam.gdc.goog/v1\n kind: Subnet\n metadata:\n labels:\n ipam.gdc.goog/overlay-network-type: External\n ipam.gdc.goog/category-type: ExternalOverlayNetwork\n name: test-subnet\n namespace: root\n spec:\n type: Root\n ipv4Request:\n cidr: 10.0.0.0/16\n networkSpec:\n staticVLANID: 100\n enableVLANID: true\n enableGateway: true"]]