Skip to main content

Get Link

Request

This API provides capability to retrieve user's Link

Security
BearerAuth
Path
appLinkIdstring, (uuid)required

App Link UUID

Example:23cd19ab-d3bb-478b-9f25-bd12a3af1914
Payload
// No request payload

Responses

App Link object

Bodyapplication/json
hrefstring, (uri)read-only

Resource URI

Example:"https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914"
typestring(AppLinkType)required

App Link Type

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

Equinix-assigned access point identifier

Example:"23cd19ab-d3bb-478b-9f25-bd12a3af1914"
namestring, (string)required

Customer-provided App Link name

Example:"Atlassian App Link"
descriptionstring, (string)

Customer-provided App Link description

Example:"Atlassian App Link in SV"
statestring, (string)(AppLinkState)

App Link lifecycle state

Enum:"PROVISIONING""PROVISIONING_FAILED""PROVISIONED""DEPROVISIONING""DEPROVISIONING_FAILED""DEPROVISIONED""REPROVISIONING"
Example:"PROVISIONING"
routerobject(AppLinkCloudRouter)required

App Link Cloud Router

ipv4Subnetstringrequired

Customer-provided IP subnet for AppLink setup (/29 or larger subnet)

Example:"192.168.10.0/29"
ipv4Addressstring, (ipv4)

App Link IP address

Example:"192.168.10.1"
bandwidthintegerrequired

App Link aggregated data transfer capacity in Mbps

Example:1000
projectobject(Project)required
changeLogobject(Changelog)

Change log

changeobject(AppLinkChange)

Current state of latest AppLink change

Response
{ "href": "https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914", "uuid": "23cd19ab-d3bb-478b-9f25-bd12a3af1914", "type": "APP_LINK", "name": "Atlassian App Link", "description": "Atlassian App Link in SV", "state": "PROVISIONED", "router": { "href": "https://api.equinix.com/fabric/v4/routers/36204584-2ae1-44f6-980f-08ecd555d9c6", "uuid": "36204584-2ae1-44f6-980f-08ecd555d9c6", "type": "XF_ROUTER" }, "ipv4Subnet": "192.168.10.0/29", "ipv4Address": "192.168.10.3", "bandwidth": 1000, "project": { "projectId": "71b55fef-fd2e-402f-ae3c-01d5f00bf2d4" }, "changeLog": { "createdBy": "test", "createdDateTime": "2026-06-27T04:20:55.471Z", "updatedBy": "test", "updatedDateTime": "2026-06-28T04:20:55.471Z" } }
Was this page helpful?