The Port API from Alianza — 5 operation(s) for port.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/alianza:alianza-port-api"curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Alianza Port API
version: '2'
description: 'Operations tagged Port across 2 of this provider''s published API definitions: alianza-apidocs-swagger2-original.json, alianza-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.d2.alianza.com
description: Development
- url: https://api.q2.alianza.com
description: QA
- url: https://api.b2.alianza.com
description: Beta
- url: https://api.alianza.com
description: Production
tags:
- name: Port
paths:
/v2/partition/{partitionId}/account/{accountId}/port/{portId}/loa:
get:
tags:
- Port
operationId: findLoa
parameters:
- name: portId
in: path
required: true
schema:
type: string
- name: X-AUTH-TOKEN
in: header
required: false
schema:
type: string
- name: partitionId
in: path
description: ID of partition
required: true
schema:
type: string
- name: accountId
in: path
description: ID of account
required: true
schema:
type: string
responses:
default:
description: successful operation
responsesObject:
default:
description: successful operation
summary: Find loa
x-summary-source: derived
post:
tags:
- Port
operationId: uploadLOA
parameters:
- name: portId
in: path
required: true
schema:
type: string
- name: X-AUTH-TOKEN
in: header
required: false
schema:
type: string
- name: partitionId
in: path
description: ID of partition
required: true
schema:
type: string
- name: accountId
in: path
description: ID of account
required: true
schema:
type: string
responses:
default:
description: successful operation
responsesObject:
default:
description: successful operation
requestBody:
content:
multipart/form-data:
schema:
originalRef: MultipartFormDataInput
$ref: '#/components/schemas/MultipartFormDataInput'
summary: Upload LOA
x-summary-source: derived
/v2/partition/{partitionId}/account/{accountId}/port/{portId}/loa/metadata:
get:
tags:
- Port
operationId: getLoaMetadata
parameters:
- name: portId
in: path
required: true
schema:
type: string
- name: X-AUTH-TOKEN
in: header
required: false
schema:
type: string
- name: partitionId
in: path
description: ID of partition
required: true
schema:
type: string
- name: accountId
in: path
description: ID of account
required: true
schema:
type: string
responses:
'200':
description: successful operation
headers: {}
responseSchema:
originalRef: LOAX
$ref: '#/components/schemas/LOAX'
content:
application/json:
schema:
originalRef: LOAX
$ref: '#/components/schemas/LOAX'
responsesObject:
'200':
description: successful operation
headers: {}
responseSchema:
originalRef: LOAX
$ref: '#/components/schemas/LOAX'
schema:
originalRef: LOAX
$ref: '#/components/schemas/LOAX'
summary: Get loa metadata
x-summary-source: derived
/v2/partition/{partitionId}/account/{accountId}/port/{portId}/triggerport:
put:
tags:
- Port
summary: Updates a service activation event on an account and triggers the port with the…
description: Use to update a specific service activation event on an account as a port request for the purpose of triggering a port with the carrier
operationId: triggerPort
parameters:
- name: portId
in: path
required: true
schema:
type: string
- name: X-AUTH-TOKEN
in: header
required: false
schema:
type: string
- name: partitionId
in: path
description: ID of partition
required: true
schema:
type: string
- name: accountId
in: path
description: ID of account
required: true
schema:
type: string
responses:
'400':
description: Invalid partition or account
responsesObject:
'400':
description: Invalid partition or account
/v2/partition/{partitionId}/account/{accountId}/port/{portId}:
get:
tags:
- Port
operationId: retrievePort
parameters:
- name: portId
in: path
required: true
schema:
type: string
- name: X-AUTH-TOKEN
in: header
required: false
schema:
type: string
- name: partitionId
in: path
description: ID of partition
required: true
schema:
type: string
- name: accountId
in: path
description: ID of account
required: true
schema:
type: string
responses:
'200':
description: successful operation
headers: {}
responseSchema:
originalRef: PortX
$ref: '#/components/schemas/PortX'
content:
application/json:
schema:
originalRef: PortX
$ref: '#/components/schemas/PortX'
responsesObject:
'200':
description: successful operation
headers: {}
responseSchema:
originalRef: PortX
$ref: '#/components/schemas/PortX'
schema:
originalRef: PortX
$ref: '#/components/schemas/PortX'
summary: Retrieve port
x-summary-source: derived
put:
tags:
- Port
operationId: updatePort
parameters:
- name: portId
in: path
required: true
schema:
type: string
- name: X-AUTH-TOKEN
in: header
required: false
schema:
type: string
- name: partitionId
in: path
description: ID of partition
required: true
schema:
type: string
- name: accountId
in: path
description: ID of account
required: true
schema:
type: string
responses:
'200':
description: successful operation
headers: {}
responseSchema:
originalRef: PortX
$ref: '#/components/schemas/PortX'
content:
application/json:
schema:
originalRef: PortX
$ref: '#/components/schemas/PortX'
responsesObject:
'200':
description: successful operation
headers: {}
responseSchema:
originalRef: PortX
$ref: '#/components/schemas/PortX'
schema:
originalRef: PortX
$ref: '#/components/schemas/PortX'
requestBody:
content:
application/json:
schema:
originalRef: PortX
$ref: '#/components/schemas/PortX'
summary: Update port
x-summary-source: derived
patch:
tags:
- Port
operationId: patchPort
parameters:
- name: portId
in: path
required: true
schema:
type: string
- name: X-AUTH-TOKEN
in: header
required: false
schema:
type: string
- name: partitionId
in: path
description: ID of partition
required: true
schema:
type: string
- name: accountId
in: path
description: ID of account
required: true
schema:
type: string
responses:
'200':
description: successful operation
headers: {}
responseSchema:
originalRef: PortX
$ref: '#/components/schemas/PortX'
content:
application/json:
schema:
originalRef: PortX
$ref: '#/components/schemas/PortX'
responsesObject:
'200':
description: successful operation
headers: {}
responseSchema:
originalRef: PortX
$ref: '#/components/schemas/PortX'
schema:
originalRef: PortX
$ref: '#/components/schemas/PortX'
requestBody:
content:
application/json:
schema:
originalRef: PortX
$ref: '#/components/schemas/PortX'
summary: Patch port
x-summary-source: derived
/v2/partition/{partitionId}/account/{accountId}/port/{portId}/cancelport:
delete:
tags:
- Port
operationId: cancelPort
parameters:
- name: portId
in: path
required: true
schema:
type: string
- name: X-AUTH-TOKEN
in: header
required: false
schema:
type: string
- name: partitionId
in: path
description: ID of partition
required: true
schema:
type: string
- name: accountId
in: path
description: ID of account
required: true
schema:
type: string
responses:
default:
description: successful operation
responsesObject:
default:
description: successful operation
summary: Cancel port
x-summary-source: derived
components:
schemas:
TelecomSettingsX:
type: object
properties:
notes:
type: string
currentCarrier:
type: string
currentCarrierName:
type: string
localReseller:
type: string
loaDate:
type: string
format: date-time
disconnectInternetService:
type: boolean
disconnectTelevisionService:
type: boolean
tnData:
type: object
additionalProperties:
originalRef: TnData
$ref: '#/components/schemas/TnData'
MultipartFormDataInput:
type: object
TnData:
type: object
properties:
tn:
type: string
rateCenter:
type: string
wireless:
type: boolean
PortX:
type: object
properties:
id:
type: string
partitionId:
type: string
accountId:
type: string
telephoneNumbers:
type: array
xml:
wrapped: true
items:
type: string
xml:
name: telephoneNumber
status:
type: string
enum:
- ACTIVE
- ACTIVATION_ON_HOLD
- ACTIVATION_PENDING
- PORT_PENDING
- CANCEL_PORT
- CANCEL_PORT_EXPIDITED
- DELETE_PENDING
- DELETED
- CANCEL_PORT_COMPLETE
- PORT_REJECTED
- INVENTORY
- INVENTORY_CLAIMED
- COOLDOWN
- RECOVERED
sendLoa:
type: boolean
loaSaved:
type: boolean
carrierId:
type: string
carrierType:
type: string
enum:
- LEVEL_3
- NO_API
- E911
- TELUS
- TELUS_API
- TELUS_ONEVOICE
- PROVTEL
- VERIZON_CARIANZA
- ONVOY_CARIANZA
- LEVEL3_CARIANZA
- BANDWIDTH
- LUMEN_IMS
- LUMEN_VOICE_LI_ELS
- SINCH
- SERVICE_PROVIDER_CARRIER
customerServiceRecord:
originalRef: CustomerServiceRecordX
$ref: '#/components/schemas/CustomerServiceRecordX'
crdDate:
type: string
format: date-time
billingTelephoneNumber:
type: string
portingWireType:
type: string
enum:
- Wireless
- Wireline
portingAuthorizedName:
type: string
wirelessAccountNumber:
type: string
wirelessPin:
type: string
focDate:
type: string
format: date-time
focDateTimeZone:
type: string
enum:
- US/Samoa
- US/Hawaii
- US/Alaska
- US/Pacific
- US/Arizona
- US/Mountain
- US/Central
- US/Eastern
- America/St_Thomas
- Canada/Pacific
- Canada/Mountain
- Canada/Central
- Canada/Eastern
- Canada/Atlantic
- Canada/Newfoundland
createdDate:
type: string
format: date-time
completedDate:
type: string
format: date-time
cancelType:
type: string
enum:
- NORMAL
- EXPIDITED
- BY_CARRIER
telecomSettings:
originalRef: TelecomSettingsX
$ref: '#/components/schemas/TelecomSettingsX'
hotCutPortId:
type: string
portNow:
type: boolean
canAcceptSMS:
type: boolean
smsCallbackUrl:
type: string
LOAX:
type: object
properties:
id:
type: string
data:
type: array
items:
type: string
format: byte
extension:
type: string
date:
type: integer
format: int64
contentType:
type: string
CustomerServiceRecordX:
type: object
properties:
id:
type: string
firstName:
type: string
middleInitial:
type: string
lastName:
type: string
businessName:
type: string
streetNumber:
type: string
streetNumberSuffix:
type: string
preDirectional:
type: string
enum:
- ''
- N
- NE
- E
- SE
- S
- SW
- W
- NW
streetName:
type: string
streetSuffix:
type: string
postDirectional:
type: string
enum:
- ''
- N
- NE
- E
- SE
- S
- SW
- W
- NW
city:
type: string
state:
type: string
country:
type: string
postalCode:
type: string
secondaryLocationDescription:
type: string
enum:
- ''
- APARTMENT
- BUILDING
- BASEMENT
- DEPARTMENT
- FLOOR
- FRONT
- HANGER
- KEY
- LOBBY
- LOT
- LOWER
- OFFICE
- PENTHOUSE
- PIER
- REAR
- ROOM
- SIDE
- SLIP
- SPACE
- SUITE
- STOP
- TRAILER
- UNIT
- UPPER
unit:
type: string
customerType:
type: string
enum:
- BUSINESS
- RESIDENTIAL
firstNameSecondary:
type: string
blockCustomerName:
type: boolean
customerName:
type: string
LOAX_2:
type: object
properties:
id:
type: string
data:
type: array
items:
pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
type: string
format: byte
extension:
type: string
date:
type: integer
format: int64
contentType:
type: string
TelecomSettingsX_2:
type: object
properties:
notes:
type: string
currentCarrier:
type: string
currentCarrierName:
type: string
localReseller:
type: string
loaDate:
type: string
format: date-time
disconnectInternetService:
type: boolean
disconnectTelevisionService:
type: boolean
tnData:
type: object
additionalProperties:
$ref: '#/components/schemas/TnData'
PortX_2:
type: object
properties:
id:
type: string
partitionId:
type: string
accountId:
type: string
telephoneNumbers:
type: array
items:
type: string
xml:
name: telephoneNumber
xml:
wrapped: true
status:
type: string
enum:
- ACTIVE
- ACTIVATION_ON_HOLD
- ACTIVATION_PENDING
- PORT_PENDING
- CANCEL_PORT
- CANCEL_PORT_EXPIDITED
- DELETE_PENDING
- DELETED
- CANCEL_PORT_COMPLETE
- PORT_REJECTED
- INVENTORY
- INVENTORY_CLAIMED
- COOLDOWN
- RECOVERED
sendLoa:
type: boolean
loaSaved:
type: boolean
carrierId:
type: string
carrierType:
type: string
enum:
- LEVEL_3
- NO_API
- E911
- TELUS
- TELUS_API
- TELUS_ONEVOICE
- PROVTEL
- VERIZON_CARIANZA
- ONVOY_CARIANZA
- LEVEL3_CARIANZA
- BANDWIDTH
- LUMEN_IMS
- LUMEN_VOICE_LI_ELS
- SINCH
- SERVICE_PROVIDER_CARRIER
customerServiceRecord:
$ref: '#/components/schemas/CustomerServiceRecordX_2'
crdDate:
type: string
format: date-time
billingTelephoneNumber:
type: string
portingWireType:
type: string
enum:
- Wireless
- Wireline
portingAuthorizedName:
type: string
wirelessAccountNumber:
type: string
wirelessPin:
type: string
maxLength: 15
focDate:
type: string
format: date-time
focDateTimeZone:
type: string
enum:
- US/Samoa
- US/Hawaii
- US/Alaska
- US/Pacific
- US/Arizona
- US/Mountain
- US/Central
- US/Eastern
- America/St_Thomas
- Canada/Pacific
- Canada/Mountain
- Canada/Central
- Canada/Eastern
- Canada/Atlantic
- Canada/Newfoundland
createdDate:
type: string
format: date-time
completedDate:
type: string
format: date-time
cancelType:
type: string
enum:
- NORMAL
- EXPIDITED
- BY_CARRIER
telecomSettings:
$ref: '#/components/schemas/TelecomSettingsX_2'
hotCutPortId:
type: string
portNow:
type: boolean
canAcceptSMS:
type: boolean
smsCallbackUrl:
type: string
MultipartFormDataInput_2:
type: object
properties:
file:
type: string
format: binary
PublicApiException:
type: object
properties:
status:
type: integer
messages:
type: array
items:
type: string
data:
type: object
additionalProperties: true
example:
key: value
key2: value2
CustomerServiceRecordX_2:
type: object
properties:
id:
type: string
firstName:
type: string
minLength: 1
maxLength: 256
middleInitial:
type: string
maxLength: 256
lastName:
type: string
maxLength: 256
businessName:
type: string
maxLength: 256
streetNumber:
type: string
streetNumberSuffix:
type: string
preDirectional:
type: string
enum:
- ''
- N
- NE
- E
- SE
- S
- SW
- W
- NW
streetName:
type: string
maxLength: 256
streetSuffix:
type: string
postDirectional:
type: string
enum:
- ''
- N
- NE
- E
- SE
- S
- SW
- W
- NW
city:
type: string
maxLength: 256
state:
type: string
description: A two-letter state abbreviation
country:
type: string
description: Alianza supports accounts in the USA and Canada.
postalCode:
type: string
secondaryLocationDescription:
type: string
enum:
- ''
- APARTMENT
- BUILDING
- BASEMENT
- DEPARTMENT
- FLOOR
- FRONT
- HANGER
- KEY
- LOBBY
- LOT
- LOWER
- OFFICE
- PENTHOUSE
- PIER
- REAR
- ROOM
- SIDE
- SLIP
- SPACE
- SUITE
- STOP
- TRAILER
- UNIT
- UPPER
unit:
type: string
maxLength: 10
customerType:
type: string
enum:
- BUSINESS
- RESIDENTIAL
firstNameSecondary:
type: string
blockCustomerName:
type: boolean
customerName:
type: string
securitySchemes:
X-Auth-Token:
type: apiKey
in: header
name: X-AUTH-TOKEN
x-refined-from:
- alianza-apidocs-swagger2-original.json
- alianza-openapi-original.yml
x-provenance:
method: harvested
publisher: Alianza
source: https://developer.alianza.com/openapi.yaml
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)