Cyxtera

  • Guides
  • API Reference
  • Release Notes
  • Cyxtera.com
  • Marketplace
  • Portal

Cyxtera Portal Documentation

Welcome to the Cyxtera Portal documentation. You'll find comprehensive guides and documentation to help you start working with Cyxtera as quickly as possible, as well as support if you get stuck. Let's jump right in!

v1.56
  • v1.46.2
  • v1.56stable
HomeGuidesRecipesAPI ReferenceReferenceRelease NotesDiscussionsPage Not FoundSearch{{ state.current().meta.title }}API Logs
    HomeGuidesAPI ReferenceRelease NotesDiscussions
discard

Cyxtera Portal

  • Getting Started
    • Glossary & Key Terms
    • Managing your Cyxtera Portal Account
    • Portal Account Types
    • Understanding Account Numbers
    • Contact Cyxtera Customer Care
  • Manage Colocation
    • Create a Ticket
    • Create a Shipment Request
    • Create an Order
    • Order Ecosystem Connect
    • Order Interconnection
  • Manage Contacts
    • Create a Contact
    • Grant Data Center Access
    • Deactivate a Contact
    • Portal User Permissions
    • Contact Notifications
  • Portal Roadmap
  • Service Descriptions

Cyxtera digital exchange

  • Cyxtera Port Quick Start Guide
    • Cyxtera Port Configuration Options
  • IP Connect Quick Start Guide
    • IP Connect: Adding additional subnets
  • Deploy Compute with Enterprise Bare Metal
  • Deploy AI Infrastructure On-Demand with Enterprise Bare Metal
  • Create a Digital Cross Connect

Providers

  • Cyxtera Marketplace
  • Cloud Connectivity with Megaport

Cyxtera Portal

  • Getting Started
    • Glossary & Key Terms
    • Managing your Cyxtera Portal Account
    • Portal Account Types
    • Understanding Account Numbers
    • Contact Cyxtera Customer Care
  • Manage Colocation
    • Create a Ticket
    • Create a Shipment Request
    • Create an Order
    • Order Ecosystem Connect
    • Order Interconnection
  • Manage Contacts
    • Create a Contact
    • Grant Data Center Access
    • Deactivate a Contact
    • Portal User Permissions
    • Contact Notifications
  • Portal Roadmap
  • Service Descriptions

Cyxtera digital exchange

  • Cyxtera Port Quick Start Guide
    • Cyxtera Port Configuration Options
  • IP Connect Quick Start Guide
    • IP Connect: Adding additional subnets
  • Deploy Compute with Enterprise Bare Metal
  • Deploy AI Infrastructure On-Demand with Enterprise Bare Metal
  • Create a Digital Cross Connect

Providers

  • Cyxtera Marketplace
  • Cloud Connectivity with Megaport

Cyxtera digital exchange

  • Getting Started
  • Integrating with CXD Cross Connects
  • Activity
    • get
      Get activity
    • get
      Get activity by customer
  • Bgp Route Advertisement
    • get
      Get bgp route advertisements
    • post
      Add bgp route advertisement
    • get
      Get bgp route advertisement
    • delete
      Delete bgp route advertisement
    • patch
      Update bgp route advertisement
    • get
      Get bgp route advertisement types
    • get
      Get lo a by customer id
    • post
      Provision bgp route advertisement
    • post
      Activate bgp route advertisement
    • post
      Approve bgp route advertisement edit
    • patch
      Reject bgp route advertisement
    • delete
      Delete edit request
  • Cabinet
    • get
      Get cabinet availability
    • get
      Get cabinets by customer id and fabric id
    • post
      Create cabinet
    • get
      Get unassigned cabinet by port speed id
    • get
      Get power types
    • patch
      Edit cabinet
  • Colocation Port
    • get
      Get colocation ports by customer id and fabric id
    • post
      Add colocation port
    • get
      Get colocation port speeds
    • get
      Get colocation port types
    • get
      Get colocation port networking types
    • get
      Get colocation port by switch port id
    • patch
      Edit colocation port
    • delete
      Delete colocation port
    • get
      Get colocation port interface status by id
    • get
      Get colocation ports by virtual network
    • get
      Get colocation ports by virtual network group
    • get
      Get colocation port by switch port
    • get
      Get colocation fiber capacity by fabric id
    • get
      Get virtual chassis switches by fabric id
    • post
      Complete colocation port configuration
    • post
      Activate colo port
    • post
      Finalize delete
  • Compute Node
    • get
      Get available compute nodes by fabric
    • get
      Get reserved compute nodes by fabric and customer
    • get
      Get compute node specifications
    • get
      Get compute node specification by id
    • get
      Get hypervisor types
    • get
      Get all compute node terms
    • patch
      Update compute node display name
    • get
      Get compute nodes by fabric
    • post
      Upload compute nodes
    • get
      Get compute node pools by fabric
    • get
      Get compute node by id
    • patch
      Edit compute node
    • get
      Get all compute node hypervisor versions
    • post
      Add hypervisor version
    • patch
      Update compute node pool
    • patch
      Update hypervisor version
  • Compute Node Group
    • get
      Get compute node groups with nodes by customer and fabric
    • post
      Add compute node group
    • get
      Get compute node group
    • patch
      Edit compute node group
    • delete
      Delete compute node group
    • get
      Get credentials by compute node group id
    • get
      Get compute node groups by virtual network id
    • get
      Get compute node groups by virtual network group id
    • get
      Get switch connectivity by node group
    • get
      Get network configuration by node group
    • post
      Add compute node
    • patch
      Patch compute nodes
    • get
      Get admin credentials by compute node group id
    • get
      Get compute node group create details
    • get
      Get compute node group delete details
    • post
      Finalize compute node group creation
    • post
      Get compute node i ps
    • post
      Finalize compute node group delete
    • post
      Finalize compute node delete
  • Configuration Item
    • get
      Get configuration item models
    • get
      Get compute node specifications
    • post
      Create compute node specification
    • get
      Get all manufacturers
    • get
      Get all redfish settings
    • get
      Get compute node specification by id
    • patch
      Update compute node specification
  • Copper Ethernet Extension
    • get
      Get copper ethernet extension by id
    • delete
      Delete copper ethernet extension
    • patch
      Edit copper ethernet extension
    • get
      Get copper ethernet extension port status
    • get
      Get copper port speeds
    • post
      Add copper ethernet extension
    • get
      Get copper ethernet extension by fabric id
    • get
      Get available copper switch port by node room id
    • post
      Activate copper ethernet extension
  • Cross Connect
    • get
      Get consumer cross connects by customer id and fabric id
    • post
      Create cross connect
    • get
      Get provider cross connects by customer id and fabric id
    • get
      Get consumer cross connect by id
    • delete
      Delete consumer cross connect by id
    • get
      Get cross connects by virtual network id
    • get
      Get provider cross connect by id
    • get
      Get cross connect type by partner identifier
    • post
      Accept cross connect delete
    • post
      Accept cross connect
    • patch
      Reject consumer cross connect by id
    • post
      Provider initiated cross connect delete
    • post
      Consumer initiated cross connect delete
  • Customer
    • get
      Get current user
    • get
      Get cxd enabled customers
    • get
      Get customer resource limit
    • post
      Add customer resource limit
    • get
      Get customer resource counts by customer id
    • get
      Get customer resource counts by fabric id
    • get
      Get vendors
    • get
      Get distribution emails by customer id
    • get
      Get customers
    • post
      Add customer
    • get
      Search customers
    • get
      Get customers by fabric id
    • patch
      Update customer
    • patch
      Update distribution emails
    • patch
      Mark as billable
    • post
      Reset customer data
    • post
      Upload resource template
    • get
      Get resource template by customer id
  • Email Event Distribution
    • get
      Get all email events
    • patch
      Updatel email event
    • get
      Get all distributions
    • patch
      Update distribution emails
  • Event
    • post
      Send event
    • post
      Send order
  • Fabric
    • get
      Get fabrics by location id
    • get
      Get fabric public configuration
    • get
      Get simple fabric versions
    • get
      Get fabric resources
    • get
      Get fabric configuration
    • patch
      Update fabric configuration
    • patch
      Update fabric
  • Location
    • post
      Create fabric
    • get
      Get locations
    • post
      Create location
    • get
      Get location by id
    • patch
      Edit location
    • post
      Create data center
    • patch
      Edit data center
  • Foundation Virtual Machine
    • get
      Get foundation vms by fabric
    • post
      Create foundation vms
    • get
      Get foundation versions
    • get
      Get nos packages
    • patch
      Edit foundation vms
  • Ip Connect
    • get
      Get rate limits
    • get
      Get ip connects by customer and fabric
    • post
      Create ip connect
    • get
      Get ip connect
    • delete
      Delete ip connect
    • patch
      Update ip connect
    • get
      Get ip connect by ip address
    • post
      Add subnet to ip connect
    • delete
      Delete ip connect subnet
    • patch
      Edit ip connect subnet
    • get
      Get ip connect by identifier
    • get
      Get ip connects by account number
    • get
      Get ip connect network configurations by id
    • post
      Provision ip connect
  • Ip Connect Layer 3
    • get
      Get ip connect layer 3 by id
    • delete
      Delete ip connect layer 3
    • get
      Get ip connect layer 3 by customer id and fabric id
    • post
      Add ip connect layer 3
    • get
      Get all dnat port types
    • get
      Get active ike authentication options
    • get
      Get active ip sec authentication options
    • patch
      Update ip connect layer 3
    • post
      Provision ip connect layer 3
    • post
      Add ip connect layer 3 subnet
    • delete
      Delete ip connect subnet
  • Job
    • get
      Get job by id
    • get
      Get job filters
    • post
      Get jobs
    • post
      Download jobs
    • post
      Get jobs by entity
  • Knowledge Base Article
    • get
      Get knowledge base articles
  • Network
    • get
      Get subnets by network id
    • get
      Get child networks by network id
    • get
      Get networks by fabric id
    • post
      Add system public network
  • Network Plane
    • get
      Get network planes
  • Node Room
    • get
      Get node rooms by fabric id
    • get
      Get node rooms for colocation port by fabric id
    • get
      Get node rooms for copper ethernet extension by fabric id
    • get
      Get node rooms by switch id
  • Pool
    • get
      Get pools by customer id and fabric id
    • post
      Add virtual network pool ranges
    • patch
      Edit virtual network pool ranges
    • delete
      Delete virtual network pool ranges
  • Price
    • get
      Get all price lists
    • post
      Upload price list
    • get
      Get all product codes
  • Report
    • get
      Download usage reports
    • get
      Get usage reports
    • get
      Download compute node usage report
    • get
      Get compute node usage report
    • get
      Download user report
    • get
      Get user report
  • SNOW Order
    • post
      Add snow order
    • get
      Get snow orders
    • get
      Get snow order
    • get
      Get customers with active orders
    • put
      Retry line item reservation
    • put
      Retry line item delete
  • Site
    • get
      Get sites
  • Subnet
    • get
      Get subnets by customer id
  • Switch
    • post
      Add aggregation leaves
    • post
      Add management switch
    • post
      Add copper switch
    • get
      Get fabric switch configurations
    • post
      Add tor pairs
    • get
      Get switches by fabric id
    • get
      Get all switches
    • get
      Get switch by id
    • patch
      Edit switch
    • get
      Get switch versions by switch id
    • get
      Get switch ports by switch id
    • get
      Get switches by parent id
    • get
      Get switch connectivity by compute node
    • post
      Enable switch port
    • post
      Add colo leaves
    • post
      Deploy minion
    • post
      Generate colo migration scripts
    • post
      Execute colo migration scripts
    • get
      Get colo migration scripts
  • Terms And Conditions
    • get
      Get latest terms and conditions
    • post
      Accept terms and conditions
    • get
      Get all terms and conditions
    • post
      Create terms and conditions
  • Test
    • post
      Test time out
  • User
    • post
      Upsert user
    • get
      Get identity providers
  • User Terms And Conditions
    • get
      Get last accepted terms and conditions by user
  • Version
    • get
      Get version
  • Virtual Network
    • get
      Get virtual network types
    • get
      Get virtual networks by customer and fabric
    • post
      Add virtual network
    • get
      Get virtual network by customer and fabric
    • delete
      Delete virtual network
    • patch
      Edit virtual network
    • get
      Get virtual networks by compute node group id
    • get
      Get virtual networks by colocation port
    • get
      Get customer vlan reservation
  • Virtual Network Group
    • get
      Get virtual network groups by customer and fabric
    • post
      Create network group
    • get
      Get virtual network by customer and fabric
    • patch
      Edit virtual network group
    • delete
      Delete virtual network group
    • get
      Get network groups by virtual network id
    • get
      Get network groups by compute node group id
    • get
      Get virtual network groups by colocation port

Contact API

  • Get Started with API Keys
  • Contact
    • get
      Download contacts
    • get
      Get contacts
    • post
      Create new contact
    • get
      Get escort contacts
    • get
      Get contact accounts
    • get
      Contact exists with user name
    • get
      Get contact notifications
    • get
      Get contact by id
    • patch
      Modify contact
    • post
      Move contact
    • post
      Activate contact
    • post
      Deactivate contact
    • delete
      Remove portal access
    • post
      Add portal access
    • get
      Get access authorizations by contact id
    • post
      Create access authorizations
    • get
      Download access authorizations by contact id
    • get
      Get visitor logs by contact id
    • get
      Get portal permissions
    • get
      Get external roles
    • post
      Resend portal invite
  • Access Authorization
    • get
      Get access authorizations
    • get
      Download access authorizations
    • get
      Get access authorization by id
    • patch
      Patch access authorization
    • post
      Revoke access authorization
    • post
      Create vlr from aar
  • Activities
    • get
      Get activity
    • get
      Get activities by company
    • get
      Get activities by contact
    • get
      Get activities report by contact
    • get
      Get activities by current user
    • post
      Post activity
  • Authentication Reports
    • get
      Get auth events by date range
    • get
      Get most recent logins
  • Badge
    • get
      Get badges
  • Billing
    • get
      Get invoices
    • get
      Download invoice
    • get
      Download addendum for invoice
    • get
      Get payments
    • get
      Get adjustments
    • get
      Download adjustment
  • Case
    • get
      Get users
    • post
      Create support case request
    • get
      Get case
    • patch
      Update case
    • get
      View case attachment
    • post
      Add case attachment
    • delete
      Delete case attachment
    • post
      Add comment
  • Visitor
    • get
      Get visitor by id
    • get
      Get visitor logs by visitor id
    • get
      Get visitor logs
    • get
      Get visitor log by id
    • delete
      Delete visitor log by id
    • patch
      Edit visitor log
    • post
      Check in visitor log
    • get
      Download visitor logs
    • post
      Create visitor
    • get
      Get visitors
    • patch
      Edit visitor
    • post
      Checkout visitor
  • Company
    • get
      Get group tours
  • Configuration Item
    • get
      Get configuration items
    • get
      Get configuration item by id
    • get
      Get all shipment locations
    • get
      Get areas search
    • get
      Get configuration item entitlement
  • Current User
    • get
      Get my publications
    • get
      View published knowledge base article attachment
    • get
      Get my publication by id
    • get
      Get my notification preferences
    • get
      Get my access authorizations
    • get
      Download access authorizations by contact id
    • patch
      Edit contact
    • get
      Get session
  • Customer
    • get
      Get ban customer detail by bp id
    • patch
      Edit customer account
    • get
      Get all companies
    • get
      Get all customer accounts
    • post
      Create feedback request
  • Data Center
    • get
      Get visitor logs by data center id
    • get
      Download packages
    • get
      Get packages by data center id
    • get
      Get change requests
    • get
      Get data center pods
    • get
      Download change requests
    • get
      Get change request by id
    • get
      Get tickets
    • get
      Download tickets
  • Pod
    • get
      Get market pods
    • get
      Get pods
    • get
      Get account data centers
  • Location
    • get
      Get location basics
  • Group Tour
    • post
      Create group tour
  • Task
    • get
      Get group tours
    • get
      Get tasks
    • get
      Get tasks for vlr
    • get
      Get catalog task by id
    • put
      Update badge request
    • put
      Update daily camera inspection
    • put
      Update monthly door perimeter inspection
    • put
      Update monthly ring down test
    • put
      Update monthly badge printer cleaning
    • put
      Front desk work order
    • put
      Update group tour
    • put
      Update generic catalog task
    • post
      Add work notes
    • post
      Add attachment
    • get
      View attachment
    • delete
      Delete attachment
    • get
      Get task configuration items
    • get
      Get case task by id
    • patch
      Update case task
    • post
      Add work notes for case task
  • Incident
    • get
      Get incidents
    • get
      Get incident by id
    • patch
      Update incident
    • get
      Get impairments
    • post
      Add work notes
    • post
      Add attachment
    • get
      View attachment
    • delete
      Delete attachment
  • Knowledge Base Article
    • get
      Get published articles
    • get
      View published knowledge base article attachment
    • get
      Get published article by id
  • Order
    • get
      Get orders
    • get
      Download orders
    • get
      Get order by id
    • post
      Add comment
    • get
      View attachment
    • post
      Add attachment
    • delete
      Delete attachment
    • post
      Create order
    • post
      Move cross connect
    • post
      Cross connect
  • Package
    • get
      Download packages
    • get
      Get packages
  • Product
    • get
      Get packages by data center id
  • Request Item
    • get
      Get request item by id
    • get
      View request item attachment
    • post
      Add request item attachment
    • delete
      Delete req itemttachment
    • post
      Update tracking numbers
    • post
      Add comment
    • get
      Get remote hands for inbound shipping ritm
    • post
      Create inbound shipment request
    • post
      Create outbound shipment request
    • get
      Get shipping carriers
    • get
      Get shipments
    • post
      Create remote hands request
  • Report
    • get
      Get security reports
    • get
      Get security report attachments
    • get
      View security report attachment
  • Space
    • get
      Get users
  • Ticket
    • get
      Get tickets
    • get
      Download tickets
  • User
    • get
      Get users
    • get
      Get user by id
    • get
      Get visitor logs by user id
    • get
      Get assignment groups
    • get
      Get assignment group users
    • post
      Create vlr from user
  • Version
    • get
      Get version
Powered by