Plans

Get IP block plan

GET/v1/networking/ip-blocks/plans/{id}

Gets a visible IP block plan with its availability, optionally in one datacenter, and the organization's pricing.

curl --request GET \
  --url https://api.serverside.com/v1/networking/ip-blocks/plans/{id} \
  --header 'Authorization: Bearer <api-key>'

{
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "specs": {
      "ipVersion": "V4",
      "prefixLength": 123,
      "usableAddresses": 123
    },
    "pricing": {
      "currency": "<string>",
      "rates": {
        "HOURLY": {
          "priceMillicents": 123,
          "effectiveMonthlyMillicents": 123,
          "termDiscount": 123
        },
        "MONTHLY": {
          "priceMillicents": 123,
          "effectiveMonthlyMillicents": 123,
          "termDiscount": 123
        },
        "QUARTERLY": {
          "priceMillicents": 123,
          "effectiveMonthlyMillicents": 123,
          "termDiscount": 123
        },
        "SEMI_ANNUALLY": {
          "priceMillicents": 123,
          "effectiveMonthlyMillicents": 123,
          "termDiscount": 123
        },
        "ANNUALLY": {
          "priceMillicents": 123,
          "effectiveMonthlyMillicents": 123,
          "termDiscount": 123
        }
      }
    },
    "availability": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "code": "<string>",
        "name": "<string>",
        "city": "<string>",
        "state": "<string>",
        "countryCode": "<string>",
        "facility": "<string>",
        "quantity": 123
      }
    ]
  }
}

Authorizations

Authorizationstringheaderrequired
Organization API key (org_...), created in the cloud console at https://cloud.serverside.com and shown once, sent as Authorization: Bearer <key>. It authenticates as the organization.

Path parameters

idstring<uuid>required
The IP block plan's id.

Query parameters

datacenterstring
A datacenter's code, such as ams1, or its id.

Response

200 · application/json

OK

successbooleanrequired
Allowed values:true
dataobject | nullrequired