Table of Contents

• About the REST APIs
• All REST Endpoints

Get Started

• Quick Start
• Authentication and Authorization
• Install and Use cURL
• Send Requests
• Status Codes
• Configurations
• Resource Inventory Management
• Service Inventory Management
• Updating the Array Attributes
• Reconfiguring Network Resources

Tasks

• Reconfigure Network Resources
  • Groom
    • Create a Groom activity
    • Delete a groom project activity
    • Get groom activity by Name
    • Process a groom activity
  • Rehome
    • Create a Rehome activity
    • Delete a rehome activity
    • Get rehome activity by Name
    • Process a rehome activity
  • ReplaceCard
    • Create a Replace Card activity
    • Delete a replace card activity
    • Get replace card activity by Name
    • Process a replace card activity
• Resource
  • Create a Resource
  • Delete a Resource
  • Get a Resource by ID
  • Get Resources
  • Update a Resource
  • Connectivity
    • Create a Connectivity
    • Delete a Connectivity
    • Get a Connectivity by connectivityIdentifier or id
    • Get Connectivities
    • Process a Connectivity
    • Update a Connectivity
  • Custom Network Address
    • Create a Custom Network Address
    • Delete a Custom Network Address
    • Get a Custom Network Address by ID
    • Get Custom Network Addresses
    • Update a Custom Network Address
  • Custom Object
    • Create a Custom Object
    • Delete a Custom Object
    • Get a Custom Object by ID
    • Get Custom Objects
    • Update a Custom Object
  • Device Interface
    • Create Device Interfaces
    • Delete a Device Interface
    • Get a Device Interface by ID
    • Get Device Interfaces
    • Update a Device Interface
  • Equipment
    • Create an Equipment Entity
    • Delete an Equipment Entity
    • Get an Equipment Entity by ID
    • Get Equipment
    • Update a Equipment
    • Associated Resources
      • Get Physical Connectors by Equipment
      • Get Physical Ports by Equipment
  • Equipment Holder
    • Get Equipment Holder by ID
    • Get Equipment Holders
  • EquipmentHolder
    • Update a EquipmentHolder
  • Flow Identifier
    • Create a Flow Identifier
    • Delete a Flow Identifier
    • Get a Flow Identifier by ID
    • Get Flow Identifiers
    • Update a Flow Identifier
  • IP Address
    • Create an IPv6 Address
    • Create IPv4 Addresses
    • Delete an IPv4 Address
    • Delete an IPv6 Address
    • Get an IPv4 Address by ID
    • Get an IPv6 Address by ID
    • Get IPv4 Addresses
    • Get IPv6 Addresses
  • IP Network
    • Create an IP Network
    • Delete an IP Network
    • Get an IP Network by ID
    • Get IP Networks
    • Update a IP Network
  • IP Subnet
    • Get an IP Subnet by ID
    • Get IP Subnets
    • Update an IP Subnet
    • Associated Resources
      • Get IPv4 Addresses by IP Subnet
      • Get IPv6 Addresses by IP Subnet
  • IPv4 Address
    • Update an IPv4 Address
  • IPv6 Address
    • Update an IPv6 Address
  • Logical Device
    • Create Logical Devices
    • Delete a Logical Device
    • Get a Logical Device by ID
    • Get Logical Devices
    • Move Logical Device with Consumers from one Property Location to another Property Location.
    • Update a Logical Device
    • Associated Resources
      • Get Device Interfaces by Logical Device
      • Get Logical Device Accounts by Logical Device
  • Logical Device Account
    • Create Logical Device Accounts
    • Delete a Logical Device Account
    • Get a Logical Device Account by ID
    • Get Logical Device Accounts
    • Update a Logical Device Account
  • Network Address Domain
    • Create a Network Address Domain
    • Delete a Network Address Domain
    • Get a Network Address Domain by ID
    • Get Network Address Domains
    • Update a Network Address Domain
  • Physical Connector
    • Create a Physical Connector
    • Delete a Physical Connector
    • Get a Physical Connector by ID
    • Get Physical Connectors
    • Update a Physical Connector
  • Physical Device
    • Create a Physical Device
    • Delete a Physical Device
    • Get a Physical Device by ID
    • Get Physical Devices
    • Update a Physical Device
    • Associated Resources
      • Get Physical Connectors by Physical Device
      • Get Physical Ports by Physical Device
  • Physical Port
    • Create a Physical Port
    • Delete a Physical Port
    • Get Physical Port by ID
    • Get Physical Ports
    • Update a Physical Port
  • Pipe
    • Create Pipes
    • Delete a Pipe
    • Get a Pipe by ID
    • Get Pipes
    • Update a Pipe
    • Pipe Termination Points
      • Get PipeTerminationPoints by Pipe
  • Pipe Termination Point
    • Get a PipeTerminationPoint
    • Update a PipeTerminationPoint
  • Telephone Number
    • Create Telephone Numbers
    • Delete a Telephone Number
    • Get a Telephone Number by ID
    • Get All Telephone Numbers
    • Update a Telephone Number
• Resource Reservation
  • Get Reservation by ID
  • Get Reservations by Reservation Number
  • Reserve a Resource to a Reservation Number
  • Reserve Resources under a single Reservation Number
  • Unreserve Reservations by Reservation Number
  • Unreserve Resources
  • Update a Reservation
• Retrieve Paths
  • Connectivity
    • Get enabling paths of Connectivity by id
  • Pipe
    • Get enabling paths of Pipe by ID
• Service
  • Create a Service
  • Delete a Service
  • Get a Service by ID
  • Get Services
  • Process a Service
  • Reverse Update of Consumable Resource
  • Update a Service
  • Bundle
    • Create/Update a Bundle Service
    • Get a Bundle Service by ID
    • Process a Bundle Service