Skip to main content

Create Subscription

Request

This API provides capability to create user's Subscription

Security
BearerAuth
Bodyapplication/jsonrequired
typestring(AppSubscriptionType)required

App Subscription Type

Default:"APP_SUBSCRIPTION"
Value:"APP_SUBSCRIPTION"
Example:"APP_SUBSCRIPTION"
sourceobject(AppSubscriptionSourceRequest)

Source details for the Subscription

targetobject(AppSubscriptionTargetRequest)

Target details for the Subscription

projectobject(Project)required
Payload
{ "type": "APP_SUBSCRIPTION", "source": { "appLink": { … }, "ipSubnets": [ … ] }, "target": { "appService": { … }, "geoScope": "GLOBAL", "prioritization": "LATENCY" }, "project": { "projectId": "71b55fef-fd2e-402f-ae3c-01d5f00bf2d4" } }

Responses

App Subscription object

Bodyapplication/json
hrefstring, (uri)read-only

Resource URI

Example:"https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3"
typestring(AppSubscriptionType)required

App Subscription Type

Default:"APP_SUBSCRIPTION"
Value:"APP_SUBSCRIPTION"
Example:"APP_SUBSCRIPTION"
uuidstring, (uuid)

Equinix-assigned access point identifier

Example:"20f3ef8e-d670-4236-86fa-bb0038adcfc3"
sourceobject(AppSubscriptionSource)required

Source details for the Subscription

targetobject(AppSubscriptionTarget)required

Target details for the Subscription

statestring(AppSubscriptionState)

App Subscription lifecycle state

Enum:"PROVISIONING""PROVISIONING_FAILED""PROVISIONED""DEPROVISIONING""DEPROVISIONING_FAILED""DEPROVISIONED""REPROVISIONING"
Example:"PROVISIONING"
projectobject(Project)required
changeLogobject(Changelog)

Change log

changeobject(AppSubscriptionChange)

Current state of latest AppSubscription change

Response
{ "href": "https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3", "uuid": "20f3ef8e-d670-4236-86fa-bb0038adcfc3", "type": "APP_SUBSCRIPTION", "source": { "appLink": { … }, "ipSubnets": [ … ] }, "target": { "appService": { … }, "geoScope": "GLOBAL", "prioritization": "LATENCY" }, "state": "PROVISIONING", "project": { "projectId": "71b55fef-fd2e-402f-ae3c-01d5f00bf2d4" }, "changeLog": { "createdBy": "test", "createdDateTime": "2026-06-27T04:20:55.471Z" } }
Was this page helpful?