Skip to content
Docs

Get Installation

Optional
GET/v1/installations/{installationId}
Get an installation
Required when Supports Installation Billing Plans is enabled in the Integration Console. Edgenivo calls this endpoint with system authentication to fetch installation state, including its current billing plan.
/v1/installations/{installationId}
const response = await fetch('/v1/installations/installationId', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});


const data = await response.json();
console.log(data);
Response
{
  "billingPlan": {
    "id": "icfg_1234567890",
    "type": "prepayment",
    "name": "Example Name",
    "scope": "installation",
    "description": "string",
    "paymentMethodRequired": "true",
    "preauthorizationAmount": "123",
    "initialCharge": "string",
    "minimumAmount": "100.00",
    "maximumAmount": "100.00",
    "maximumAmountAutoPurchasePerPeriod": "100.00",
    "cost": "string",
    "details": [
      {
        "label": "string",
        "value": "string"
      }
    ],
    "highlightedDetails": [
      {
        "label": "string",
        "value": "string"
      }
    ],
    "quote": [
      {
        "line": "string",
        "amount": "100.00"
      }
    ],
    "effectiveDate": "2024-01-01T00:00:00Z",
    "disabled": "true"
  },
  "notification": {
    "level": "info",
    "title": "string",
    "message": "string",
    "href": "https://example.com"
  }
}
Errors
{
  "error": {
    "code": "forbidden",
    "message": "string",
    "user": {
      "message": "string",
      "url": "https://example.com"
    }
  }
}

Authentication

AuthorizationSystem Authentication

Default authentication mechanism

Path parameters

installationIdstringRequired

Header parameters

X-Edgenivo-AuthstringOptional
The auth style used in the request (system, user, etc)

Response

200The installation
billingPlanobjectOptional
The billing plan for the installation. If not set, the installation is billed on resource level.
notificationobjectOptional
Installation's active notification. Example: { "level": "warn", "title": "Account is exceeding the maximum allowed storage no the current plan" }. Return null to remove any current installation notification.

Errors

403Operation failed because the authentication is not allowed to perform this operation
errorobjectRequired