Skip to main content

Create Loa

Request

The API provides capability to create a new Loa

Security
BearerAuth
Bodyapplication/jsonrequired
One of:

Issue Loa

typestring(LoaType)required

Type of Letter of Authorization

Enum:"CAGE_LOA""PATCH_PANEL_LOA""PATCH_PANEL_PORT_LOA"
Example:"PATCH_PANEL_PORT_LOA"
namestring, [ 3 .. 50 ] charactersrequired

A short, descriptive name for this LOA.

Example:"LOA-Equinix-SV1-2026"
descriptionstring, [ 0 .. 450 ] characters

Additional context about this LOA.

Example:"Authorization for patch panel port access to Equinix at SV1"
authorizedProductTypestring(LoaProductType)required

Product type associated with this LOA.
XC - Cross Connect
XF_PORT - Fabric Port
VD - Network Edge

Enum:"XC""XF_PORT""VD"
Example:"XC"
expirationDateTimestring, (date-time)(LoaExpiration)

Date and time when this LOA expires.
Default to 3 months from the creation date

Example:"2026-11-06T07:00:00Z"
requestorobject(LoaRequestor)

Requestor

demarcationPointobject(LoaDemarcationPoint)required

Specifies the demarcation point.
For CAGE_LOA - cageUniqueSpaceId is required.
For PATCH_PANEL_LOA - patchPanelId is required.
For PATCH_PANEL_PORT_LOA - patchPanelId, patchPanelPortA, patchPanelPortB and connectorType is required.

Payload
{ "type": "CAGE_LOA", "name": "LOA-Equinix-SV1-2026", "description": "Authorization for cage access to Equinix at SV1", "authorizedProductType": "XC", "expirationDateTime": "2026-12-31T23:59:59Z", "requestor": { "email": "user@org1.com", "orgId": 95900, "orgName": "organizationName1" }, "demarcationPoint": { "cageUniqueSpaceId": "AM7:0G:0202" } }

Responses

Accepted

Bodyapplication/json
hrefstring, (uri)

URI of this LOA resource.

Example:"https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2"
uuidstring, (uuid)

Unique identifier of this LOA.

Example:"29cc7878-54e3-4e1a-8651-87a61354bac2"
typestring(LoaType)

Type of Letter of Authorization

Enum:"CAGE_LOA""PATCH_PANEL_LOA""PATCH_PANEL_PORT_LOA"
Example:"PATCH_PANEL_PORT_LOA"
namestring

A short, descriptive name for this LOA

Example:"LOA-Equinix-SV1-2026"
descriptionstring

Additional context about this LOA

Example:"Authorization for patch panel port access to Equinix at SV1"
authorizedProductTypestring(LoaProductType)

Product type associated with this LOA.
XC - Cross Connect
XF_PORT - Fabric Port
VD - Network Edge

Enum:"XC""XF_PORT""VD"
Example:"XC"
statestring(LoaState)

Current lifecycle state of the LOA.

Enum:"PENDING""FAILED""PENDING_AUTHORIZATION""PENDING_ACCEPTANCE""CANCELLED""INACTIVE""ACTIVE""EXPIRED"
Example:"ACTIVE"
operationobject
requestorobject(LoaRequestor)

Requestor

issuerobject(LoaIssuer)

Issuer

demarcationPointobject(LoaDemarcationPoint)

Specifies the demarcation point.
For CAGE_LOA - cageUniqueSpaceId is required.
For PATCH_PANEL_LOA - patchPanelId is required.
For PATCH_PANEL_PORT_LOA - patchPanelId, patchPanelPortA, patchPanelPortB and connectorType is required.

locationobject(LoaLocation)

Eligible location where LOA can be issued.

expirationDateTimestring, (date-time)(LoaExpiration)

Date and time when this LOA expires.
Default to 3 months from the creation date

Example:"2026-11-06T07:00:00Z"
changeLogobject(LoaChangelog)

Change log

Response
{ "href": "https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2", "uuid": "29cc7878-54e3-4e1a-8651-87a61354bac2", "type": "PATCH_PANEL_PORT_LOA", "name": "LOA-Equinix-SV1-2026", "description": "Authorization for cage access to Equinix at SV1", "authorizedProductType": "XC", "state": "PENDING_AUTHORIZATION", "requestor": { "email": "user@org1.com", "orgId": 95900, "orgName": "organizationName1" }, "issuer": { "email": "user@org2.com", "orgId": 95901, "orgName": "organizationName2" }, "location": { "ibxCode": "SV1" }, "changeLog": { "createdDateTime": "2026-07-24T06:50:46Z", "createdBy": "user", "createdByEmail": "user@org1.com" } }
Was this page helpful?