Network Services Platform REST API - v2
This API describes the REST interface to interact with the Network Services Platform
BasePath:/sdn
Access
[ Jump to Models ]
Table of Contents
get /api/v2/generic/{uuid}get /api/v2/generic/application-id/{id}get /api/v2/generic/consumed/{uuid}get /api/v2/generic/tenants/{uuid}put /api/v2/generic/application-id/{id}/{appId}get /api/v2/ne/{uuid}get /api/v2/ne/system/{systemId}get /api/v2/neget /api/v2/physicallinks/{uuid}get /api/v2/physicallinksget /api/v2/policy/rd-rt-rangesget /api/v2/policy/tunnel-selectionsput /api/v2/policy/rd-rt-ranges/{policyId}put /api/v2/policy/tunnel-selections/{policyId}get /api/v2/ports/{portUuid}get /api/v2/ports/ne/{neUuid}/servicetype/{serviceType}get /api/v2/ports/servicetype/{serviceType}get /api/v2/ports/tenant/{tenantUuid}get /api/v2/security/token/{userName}/{password}post /api/v2/servicespost /api/v2/services/elanspost /api/v2/services/elinespost /api/v2/services/l3-vpnspost /api/v2/services/lagspost /api/v2/services/opticaldelete /api/v2/services/{uuid}get /api/v2/services/{uuid}get /api/v2/services/{serviceUuid}/endpointsget /api/v2/services/tenant/{uuid}get /api/v2/servicesput /api/v2/services/elans/{serviceUuid}put /api/v2/services/elines/{serviceUuid}put /api/v2/services/l3-vpns/{serviceUuid}get /api/v2/system/stateget /api/v2/system/resync-nmspost /api/v2/template/elan-servicespost /api/v2/template/eline-servicespost /api/v2/template/l3-vpn-servicespost /api/v2/template/lag-servicespost /api/v2/template/och-servicespost /api/v2/template/odu-servicespost /api/v2/template/qosdelete /api/v2/template/elan-services/{templateId}delete /api/v2/template/eline-services/{templateId}delete /api/v2/template/l3-vpn-services/{templateId}delete /api/v2/template/lag-services/{templateId}delete /api/v2/template/och-services/{templateId}delete /api/v2/template/odu-services/{templateId}delete /api/v2/template/qos/{templateId}get /api/v2/template/elan-servicesget /api/v2/template/eline-servicesget /api/v2/template/l3-vpn-servicesget /api/v2/template/lag-servicesget /api/v2/template/och-servicesget /api/v2/template/odu-servicesget /api/v2/template/qosget /api/v2/template/tunnel-creationsget /api/v2/template/elan-services/{templateId}get /api/v2/template/eline-services/{templateId}get /api/v2/template/l3-vpn-services/{templateId}get /api/v2/template/lag-services/{templateId}get /api/v2/template/och-services/{templateId}get /api/v2/template/odu-services/{templateId}get /api/v2/template/qos/{templateId}put /api/v2/template/elan-services/{templateId}put /api/v2/template/eline-services/{templateId}put /api/v2/template/l3-vpn-services/{templateId}put /api/v2/template/lag-services/{templateId}put /api/v2/template/och-services/{templateId}put /api/v2/template/odu-services/{templateId}put /api/v2/template/qos/{templateId}put /api/v2/template/tunnel-creations/{templateId}post /api/v2/tenants/{tenantUuid}/resourcespost /api/v2/tenantspost /api/v2/tenants/{tenantUuid}/user/{userUuid}/role/{roleType}delete /api/v2/tenants/{tenantUuid}delete /api/v2/tenants/{tenantUuid}/resourcesdelete /api/v2/tenants/{tenantUuid}/user/{userUuid}get /api/v2/tenants/{tenantUuid}get /api/v2/tenants/{tenantUuid}/resourcesget /api/v2/tenants/{tenantUuid}/user/{userUuid}get /api/v2/tenantsget /api/v2/tenants/resync/{provider}post /api/v2/usersdelete /api/v2/users/{userUuid}get /api/v2/users/{userUuid}get /api/v2/users/{userUuid}/tenantsget /api/v2/users
Up
get /api/v2/generic/{uuid}
Find an object by a unique identifier (get)
Find an object by a unique identifier
Path parameters
uuid (required)
Path Parameter — The unique identifier for the query
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«BaseEntity»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
get /api/v2/generic/application-id/{id}
Find an object by Application ID (getApplicationId)
Find an object by Application ID
Path parameters
id (required)
Path Parameter — The Application ID of the object
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«BaseEntity»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
get /api/v2/generic/consumed/{uuid}
Find all objects being consumed by an object (getConsumed)
Find all objects being consumed by an object
Path parameters
uuid (required)
Path Parameter — The unique identifier of the object
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«List«string»»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
get /api/v2/generic/tenants/{uuid}
Query all tenants assigned to an object (getTenants)
Query all tenants assigned to an object
Path parameters
uuid (required)
Path Parameter — The unique identifiers for the object
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«string»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
put /api/v2/generic/application-id/{id}/{appId}
Set an object Application ID (setApplicationId)
Set an object Application ID
Path parameters
id (required)
Path Parameter — The unique identifier of the object
appId (required)
Path Parameter — The Application ID to be set
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«BaseEntity»
201
Created
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Find a network element by a unique identifier (get)
Find a network element by a unique identifier
Path parameters
uuid (required)
Path Parameter — The unique identifier for the query
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«NetworkElement»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
get /api/v2/ne/system/{systemId}
Query a unique identifier for a Network Element by System ID (getSystem)
Query a unique identifier for a Network Element by System ID
Path parameters
systemId (required)
Path Parameter — The System ID for the Network Element to be queried
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«NetworkElement»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Query all Network Elements (gets)
Query all Network Elements
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«List«NetworkElement»»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
get /api/v2/physicallinks/{uuid}
Find a physical link by a unique identifier (get)
Find a physical link by a unique identifier
Path parameters
uuid (required)
Path Parameter — The unique identifier for the query
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«PhysicalLink»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
get /api/v2/physicallinks
Query all physical links (gets)
Query all physical links
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«List«PhysicalLink»»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
get /api/v2/policy/rd-rt-ranges
Query all L3VPN RT/RD policies (getAllRdRtRanges)
Query all L3VPN RT/RD policies
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«List«L3vpnRdRtPolicy»»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
get /api/v2/policy/tunnel-selections
Query all tunnel selection policies (getAllTunnelSelections)
Query all tunnel selection policies
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«List«TunnelSelectionTemplate»»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
put /api/v2/policy/rd-rt-ranges/{policyId}
Update a L3VPN RT/RD policy (updateRdRtRanges)
Update a L3VPN RT/RD policy
Path parameters
policyId (required)
Path Parameter — The unique ID of the policy that is being modified
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (optional)
Body Parameter — L3VPN RT/RD policy
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«boolean»
201
Created
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
put /api/v2/policy/tunnel-selections/{policyId}
Update a tunnel selections policy (updateTunnelSelections)
Update a tunnel selections policy
Path parameters
policyId (required)
Path Parameter — The unique ID of the policy that is being modified
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (optional)
Body Parameter — The tunnel selection template controls system behaviour when selecting tunnels in the network
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«boolean»
201
Created
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
get /api/v2/ports/{portUuid}
Find a port by unique identifier (get)
Find a port by unique identifier
Path parameters
portUuid (required)
Path Parameter — The unique identifier for the query
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«Port»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
get /api/v2/ports/ne/{neUuid}/servicetype/{serviceType}
Query all ports of the provided network element of a service type (getNe)
Query all ports of the provided network element of a service type
Path parameters
neUuid (required)
Path Parameter — The unique identifier of the network element to be queried
serviceType (required)
Path Parameter — The service type for the port to be queried
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«List«Port»»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
get /api/v2/ports/servicetype/{serviceType}
Query all ports in the network which support a given service type (getServicetype)
Query all ports in the network which support a given service type
Path parameters
serviceType (required)
Path Parameter — The service type for the port to be queried
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«List«Port»»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
get /api/v2/ports/tenant/{tenantUuid}
Query all ports in the network which are assigned to the provided Tenant (getTenant)
Query all ports in the network which are assigned to the provided Tenant
Path parameters
tenantUuid (required)
Path Parameter — The unique identifier of the tenant to be queried
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«List«Port»»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
get /api/v2/security/token/{userName}/{password}
Acquire a token (getToken)
Acquire a token
Path parameters
userName (required)
Path Parameter — The username to be associated with the acquired token
password (required)
Path Parameter — The password used with the specified username
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«NspToken»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Create a service using the abstract service defintion (create)
Create a service using the abstract service defintion
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (optional)
Body Parameter — The abstract service request. An abstract service is defined by policy and endpoints. Once deployed an abstract service can be modified in the same manner as a normalized service.
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«BaseService»
201
Created
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
post /api/v2/services/elans
Create an ELAN VPN service (createElans)
Create an ELAN VPN service
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (optional)
Body Parameter — The normalized ELAN service request
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«BaseService»
201
Created
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
post /api/v2/services/elines
Create an IP or optical ELINE service (createElines)
Create an IP or optical ELINE service
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (optional)
Body Parameter — The normalized IP or Optical ELINE service request. This object is used to create and modify service entities in the network.
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«BaseService»
201
Created
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
post /api/v2/services/l3-vpns
Create an L3 VPN service (createL3Vpns)
Create an L3 VPN service
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (optional)
Body Parameter — The normalized L3 VPN service request. This object is used to create and modify service entities in the network.
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«BaseService»
201
Created
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
post /api/v2/services/lags
Create or modify a LAG service (createLags)
Create or modify a LAG service
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (optional)
Body Parameter — The normalized LAG service request. This object is used to create and modify service entities in the network.
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«BaseService»
201
Created
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
post /api/v2/services/optical
Create or modify an optical service (createOptical)
Create or modify an optical service
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (optional)
Body Parameter — The normalized Optical service request. This object is used to create and modify service entities in the network.
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«BaseService»
201
Created
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
delete /api/v2/services/{uuid}
Delete a service (delete)
Delete a service
Path parameters
uuid (required)
Path Parameter — The unique identifier of the service to be deleted
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«boolean»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
204
No Content
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
get /api/v2/services/{uuid}
Find a service by a unique identifier (get)
Find a service by a unique identifier
Path parameters
uuid (required)
Path Parameter — The unique identifier for the query
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«BaseService»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
get /api/v2/services/{serviceUuid}/endpoints
Query all endpoints associated to a service object (getEndpoints)
Query all endpoints associated to a service object
Path parameters
serviceUuid (required)
Path Parameter — The unique identifier for the service to be queried
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«List«BaseServiceEndpoint»»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
get /api/v2/services/tenant/{uuid}
Query all services which are assigned to a tenant (getTenant)
Query all services which are assigned to a tenant
Path parameters
uuid (required)
Path Parameter — The unique identifier for the tenant to be queried
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«List«BaseService»»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Query all service objects (gets)
Query all service objects
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«List«BaseService»»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
put /api/v2/services/elans/{serviceUuid}
Modify an ELAN service (updateElans)
Modify an ELAN service
Path parameters
serviceUuid (required)
Path Parameter — The unique identifier of the service that is being modified
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (optional)
Body Parameter — The normalized ELAN service request
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«BaseService»
201
Created
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
put /api/v2/services/elines/{serviceUuid}
Modify an IP or optical ELINE service (updateElines)
Modify an IP or optical ELINE service
Path parameters
serviceUuid (required)
Path Parameter — The unique identifier of the service that is being modified
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (optional)
Body Parameter — The normalized IP or Optical ELINE service request. This object is used to create and modify service entities in the network.
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«BaseService»
201
Created
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
put /api/v2/services/l3-vpns/{serviceUuid}
Modify an L3 VPN service (updateL3Vpns)
Modify an L3 VPN service
Path parameters
serviceUuid (required)
Path Parameter — The unique identifier of the service that is being modified
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (optional)
Body Parameter — The normalized L3 VPN service request. This object is used to create and modify service entities in the network.
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«BaseService»
201
Created
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
get /api/v2/system/state
Retreives the state of the system (getState)
Retreives the state of the system
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«string»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
get /api/v2/system/resync-nms
Triggers a data synchronization with the connected NMS (resyncNms)
Triggers a data synchronization with the connected NMS
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«boolean»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
post /api/v2/template/elan-services
Create an Elan service creation template (createElanServices)
Create an Elan service creation template
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (optional)
Body Parameter — This template is used during E-LAN service creation
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«ElanServiceCreationTemplate»
201
Created
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
post /api/v2/template/eline-services
Create an ELINE service creation template (createElineServices)
Create an ELINE service creation template
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (optional)
Body Parameter — This template is used during ELINE service creation
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«ElineServiceCreationTemplate»
201
Created
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
post /api/v2/template/l3-vpn-services
Create a L3 VPN service creation template (createL3VpnServices)
Create a L3 VPN service creation template
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (optional)
Body Parameter — This template is used during L3 VPN service creation
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«L3vpnServiceCreationTemplate»
201
Created
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
post /api/v2/template/lag-services
Create a LAG service creation template (createLagServices)
Create a LAG service creation template
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (optional)
Body Parameter — This template is used during LAG service creation
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«LagServiceCreationTemplate»
201
Created
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
post /api/v2/template/och-services
Create an OCH service creation template (createOchServices)
Create an OCH service creation template
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (optional)
Body Parameter — This template is used during OCH service creation
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«OchServiceCreationTemplate»
201
Created
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
post /api/v2/template/odu-services
Create an ODU service creation template (createOduServices)
Create an ODU service creation template
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (optional)
Body Parameter — This template is used during ODU service creation
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«OduServiceCreationTemplate»
201
Created
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
post /api/v2/template/qos
Create a QoS template (createQos)
Create a QoS template
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (optional)
Body Parameter — Qos template that defines cir & pir
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«QosTemplate»
201
Created
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
delete /api/v2/template/elan-services/{templateId}
Delete an existing template (deleteElanServices)
Delete an existing template
Path parameters
templateId (required)
Path Parameter — templateId
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«boolean»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
204
No Content
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
delete /api/v2/template/eline-services/{templateId}
Delete an existing template (deleteElineServices)
Delete an existing template
Path parameters
templateId (required)
Path Parameter — templateId
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«boolean»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
204
No Content
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
delete /api/v2/template/l3-vpn-services/{templateId}
Delete an existing L3 VPN service creation template (deleteL3VpnServices)
Delete an existing L3 VPN service creation template
Path parameters
templateId (required)
Path Parameter — templateId
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«boolean»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
204
No Content
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
delete /api/v2/template/lag-services/{templateId}
Delete an existing LAG service creation template (deleteLagServices)
Delete an existing LAG service creation template
Path parameters
templateId (required)
Path Parameter — templateId
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«boolean»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
204
No Content
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
delete /api/v2/template/och-services/{templateId}
Delete an existing OCH service creation template (deleteOchServices)
Delete an existing OCH service creation template
Path parameters
templateId (required)
Path Parameter — templateId
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«boolean»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
204
No Content
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
delete /api/v2/template/odu-services/{templateId}
Delete an existing ODU service creation template (deleteOduServices)
Delete an existing ODU service creation template
Path parameters
templateId (required)
Path Parameter — templateId
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«boolean»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
204
No Content
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
delete /api/v2/template/qos/{templateId}
Delete an existing QoS template (deleteQos)
Delete an existing QoS template
Path parameters
templateId (required)
Path Parameter — templateId
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«boolean»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
204
No Content
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
get /api/v2/template/elan-services
Query all Elan services (getAllElanServices)
Query all Elan services
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«List«ElanServiceCreationTemplate»»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
get /api/v2/template/eline-services
Query all ELINE services (getAllElineServices)
Query all ELINE services
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«List«ElineServiceCreationTemplate»»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
get /api/v2/template/l3-vpn-services
Query all L3 VPN service creation templates (getAllL3VpnServices)
Query all L3 VPN service creation templates
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«List«L3vpnServiceCreationTemplate»»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
get /api/v2/template/lag-services
Query all LAG service creation templates (getAllLagServices)
Query all LAG service creation templates
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«List«LagServiceCreationTemplate»»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
get /api/v2/template/och-services
Query all OCH service creation templates (getAllOchServices)
Query all OCH service creation templates
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«List«OchServiceCreationTemplate»»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
get /api/v2/template/odu-services
Query all ODU service creation templates (getAllOduServices)
Query all ODU service creation templates
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«List«OduServiceCreationTemplate»»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
get /api/v2/template/qos
Query all QoS templates (getAllQos)
Query all QoS templates
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«List«QosTemplate»»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
get /api/v2/template/tunnel-creations
Query all tunnel creation templates (getAllTunnelCreations)
Query all tunnel creation templates
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«List«TunnelCreationTemplate»»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
get /api/v2/template/elan-services/{templateId}
Query an Elan service by its unique identifier (getElanServices)
Query an Elan service by its unique identifier
Path parameters
templateId (required)
Path Parameter — templateId
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«ElanServiceCreationTemplate»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
get /api/v2/template/eline-services/{templateId}
Query an ELINE service by its unique identifier (getElineServices)
Query an ELINE service by its unique identifier
Path parameters
templateId (required)
Path Parameter — templateId
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«ElineServiceCreationTemplate»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
get /api/v2/template/l3-vpn-services/{templateId}
Query L3 VPN service creation template by its unique identifier (getL3VpnServices)
Query L3 VPN service creation template by its unique identifier
Path parameters
templateId (required)
Path Parameter — templateId
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«L3vpnServiceCreationTemplate»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
get /api/v2/template/lag-services/{templateId}
Query LAG service creation template by its unique identifier (getLagServices)
Query LAG service creation template by its unique identifier
Path parameters
templateId (required)
Path Parameter — templateId
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«LagServiceCreationTemplate»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
get /api/v2/template/och-services/{templateId}
Query OCH service creation template by its unique identifier (getOchServices)
Query OCH service creation template by its unique identifier
Path parameters
templateId (required)
Path Parameter — templateId
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«OchServiceCreationTemplate»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
get /api/v2/template/odu-services/{templateId}
Query ODU service creation template by its unique identifier (getOduServices)
Query ODU service creation template by its unique identifier
Path parameters
templateId (required)
Path Parameter — templateId
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«OduServiceCreationTemplate»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
get /api/v2/template/qos/{templateId}
Query QoS template by its unique identifier (getQos)
Query QoS template by its unique identifier
Path parameters
templateId (required)
Path Parameter — templateId
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«QosTemplate»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
put /api/v2/template/elan-services/{templateId}
Update an existing Elan service (updateElanServices)
Update an existing Elan service
Path parameters
templateId (required)
Path Parameter — The unique ID of the template that is being modified
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (optional)
Body Parameter — This template is used during E-LAN service creation
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«boolean»
201
Created
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
put /api/v2/template/eline-services/{templateId}
Update an existing ELINE service (updateElineServices)
Update an existing ELINE service
Path parameters
templateId (required)
Path Parameter — The unique ID of the template that is being modified
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (optional)
Body Parameter — This template is used during ELINE service creation
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«boolean»
201
Created
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
put /api/v2/template/l3-vpn-services/{templateId}
Update a L3 VPN service creation template (updateL3VpnServices)
Update a L3 VPN service creation template
Path parameters
templateId (required)
Path Parameter — The unique ID of the template that is being modified
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (optional)
Body Parameter — This template is used during L3 VPN service creation
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«boolean»
201
Created
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
put /api/v2/template/lag-services/{templateId}
Update a LAG service creation template (updateLagServices)
Update a LAG service creation template
Path parameters
templateId (required)
Path Parameter — The unique ID of the template that is being modified
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (optional)
Body Parameter — This template is used during LAG service creation
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«boolean»
201
Created
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
put /api/v2/template/och-services/{templateId}
Update an OCH service creation template (updateOchServices)
Update an OCH service creation template
Path parameters
templateId (required)
Path Parameter — The unique identifier of the template that is being modified
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (optional)
Body Parameter — This template is used during OCH service creation
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«boolean»
201
Created
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
put /api/v2/template/odu-services/{templateId}
Update an ODU service creation template (updateOduServices)
Update an ODU service creation template
Path parameters
templateId (required)
Path Parameter — The unique ID of the template that is being modified
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (optional)
Body Parameter — This template is used during ODU service creation
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«boolean»
201
Created
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
put /api/v2/template/qos/{templateId}
Update a QoS template (updateQos)
Update a QoS template
Path parameters
templateId (required)
Path Parameter — The unique identifier of the template that is being modified
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (optional)
Body Parameter — Qos template that defines cir & pir
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«boolean»
201
Created
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
put /api/v2/template/tunnel-creations/{templateId}
Update a tunnel creation template (updateTunnelCreations)
Update a tunnel creation template
Path parameters
templateId (required)
Path Parameter — The unique ID of the template that is being modified
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (optional)
Body Parameter — The tunnel creation template controls system behaviour when automatically creating tunnels in the network
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«boolean»
201
Created
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
post /api/v2/tenants/{tenantUuid}/resources
Assign resources to a tenant (addResources)
Assign resources to a tenant
Path parameters
tenantUuid (required)
Path Parameter — The unique identifier of the tenant to be modified
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (optional)
Body Parameter — The resource unique identifier(s) to be assigned to the tenant
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«boolean»
201
Created
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Create an NSP Tenant (create)
Create an NSP Tenant
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (optional)
Body Parameter — A tenant is a logical group that allows the assigning of network resources
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«Tenant»
201
Created
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
post /api/v2/tenants/{tenantUuid}/user/{userUuid}/role/{roleType}
Assign a user to a tenant (createUser)
Assign a user to a tenant
Path parameters
tenantUuid (required)
Path Parameter — The unique identifier of the tenant to be modified
userUuid (required)
Path Parameter — The unique identifier of the user to be assigned
roleType (required)
Path Parameter — The role that the user will be assigned on the tenant
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«boolean»
201
Created
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
delete /api/v2/tenants/{tenantUuid}
Delete a Tenant (delete)
Delete a Tenant
Path parameters
tenantUuid (required)
Path Parameter — The unique identifier of the Tenant to be deleted
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«boolean»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
204
No Content
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
delete /api/v2/tenants/{tenantUuid}/resources
Remove resources from a tenant (deleteResources)
Remove resources from a tenant
Path parameters
tenantUuid (required)
Path Parameter — The unique identifier of the tenant to be modified
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (optional)
Body Parameter — The resource unique identifier(s) to be removed from the tenant
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«boolean»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
204
No Content
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
delete /api/v2/tenants/{tenantUuid}/user/{userUuid}
Remove a user from a tenant (deleteUser)
Remove a user from a tenant
Path parameters
tenantUuid (required)
Path Parameter — The unique identifier of the tenant to which the user is assigned
userUuid (required)
Path Parameter — The unique identifier of the user to be removed
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«boolean»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
204
No Content
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
get /api/v2/tenants/{tenantUuid}
Find a Tenant (get)
Find a Tenant
Path parameters
tenantUuid (required)
Path Parameter — The unique identifier for the query
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«Tenant»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
get /api/v2/tenants/{tenantUuid}/resources
Find all resources assigned to a tenant (getResources)
Find all resources assigned to a tenant
Path parameters
tenantUuid (required)
Path Parameter — The unique identifier for the tenant
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«List«BaseEntity»»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
get /api/v2/tenants/{tenantUuid}/user/{userUuid}
Find a user's assigned role on a tenant (getUser)
Find a user's assigned role on a tenant
Path parameters
tenantUuid (required)
Path Parameter — The unique identifier of the tenant to which the user is assigned
userUuid (required)
Path Parameter — The unique identifier of the user to be found
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«List«string»»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Query all Tenants (gets)
Query all Tenants
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«List«Tenant»»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
get /api/v2/tenants/resync/{provider}
Resynchronize data with an Identity Provider (resync)
Resynchronize data with an Identity Provider
Path parameters
provider (required)
Path Parameter — The Identity Provider in which to resynchronize data
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«boolean»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Create a user (create)
Create a user
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (optional)
Body Parameter — The user authentication information
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«User»
201
Created
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
delete /api/v2/users/{userUuid}
Delete a user (delete)
Delete a user
Path parameters
userUuid (required)
Path Parameter — The unique identifier for the user to be deleted
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«boolean»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
204
No Content
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
get /api/v2/users/{userUuid}
Find a user by a unique identifier (get)
Find a user by a unique identifier
Path parameters
userUuid (required)
Path Parameter — The unique identifier for the query
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«User»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Up
get /api/v2/users/{userUuid}/tenants
Find all tenants assigned to user based on unique identifier (getTenants)
Find all tenants assigned to user based on unique identifier
Path parameters
userUuid (required)
Path Parameter — The unique identifier for the User to be queried
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«List«Tenant»»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
Query all Users (gets)
Query all Users
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«List«User»»
400
Bad Request - Malformed content or invalid data provided
ErrorResponseData
401
Unauthorized - Authentication rejected
ErrorResponseData
500
Internal Server Error - Unrecognized system error
ErrorResponseData
403
Forbidden - Authorization rejected
ErrorResponseData
404
Not Found - Resource does not exist
ErrorResponseData
409
Conflict - System not ready
ErrorResponseData
[ Jump to Methods ]
Table of Contents
AbstractServiceBaseEntityBaseServiceBaseServiceEndpointElanServiceCreationTemplateElineRequestDataElineServiceCreationTemplateEndpointListErrorMessagesErrorResponseDataGeoLocationGroupConnectionIpAddressIpElanServiceRequestIpL3ServiceRequestIpPrefixIpv4AddressIpv4PrefixIpv6AddressIpv6PrefixL2EndpointL3EndpointL3vpnRdRtPolicyL3vpnServiceCreationTemplateLagRequestLagServiceCreationTemplateLinkCostNetworkElementNspTokenOchServiceCreationTemplateOduServiceCreationTemplateOpticsRequestPhysicalLinkPortQosTemplateRequest«AbstractService»Request«ElanServiceCreationTemplate»Request«ElineRequestData»Request«ElineServiceCreationTemplate»Request«IpElanServiceRequest»Request«IpL3ServiceRequest»Request«L3vpnRdRtPolicy»Request«L3vpnServiceCreationTemplate»Request«LagRequest»Request«LagServiceCreationTemplate»Request«List«string»»Request«OchServiceCreationTemplate»Request«OduServiceCreationTemplate»Request«OpticsRequest»Request«QosTemplate»Request«Tenant»Request«TunnelCreationTemplate»Request«TunnelSelectionTemplate»Request«UserInfo»ResponseData«BaseEntity»ResponseData«BaseService»ResponseData«ElanServiceCreationTemplate»ResponseData«ElineServiceCreationTemplate»ResponseData«L3vpnServiceCreationTemplate»ResponseData«LagServiceCreationTemplate»ResponseData«List«BaseEntity»»ResponseData«List«BaseServiceEndpoint»»ResponseData«List«BaseService»»ResponseData«List«ElanServiceCreationTemplate»»ResponseData«List«ElineServiceCreationTemplate»»ResponseData«List«L3vpnRdRtPolicy»»ResponseData«List«L3vpnServiceCreationTemplate»»ResponseData«List«LagServiceCreationTemplate»»ResponseData«List«NetworkElement»»ResponseData«List«OchServiceCreationTemplate»»ResponseData«List«OduServiceCreationTemplate»»ResponseData«List«PhysicalLink»»ResponseData«List«Port»»ResponseData«List«QosTemplate»»ResponseData«List«Tenant»»ResponseData«List«TunnelCreationTemplate»»ResponseData«List«TunnelSelectionTemplate»»ResponseData«List«User»»ResponseData«List«string»»ResponseData«NetworkElement»ResponseData«NspToken»ResponseData«OchServiceCreationTemplate»ResponseData«OduServiceCreationTemplate»ResponseData«PhysicalLink»ResponseData«Port»ResponseData«QosTemplate»ResponseData«Tenant»ResponseData«User»ResponseData«boolean»ResponseData«string»Response«BaseEntity»Response«BaseService»Response«ElanServiceCreationTemplate»Response«ElineServiceCreationTemplate»Response«ErrorMessages»Response«L3vpnServiceCreationTemplate»Response«LagServiceCreationTemplate»Response«List«BaseEntity»»Response«List«BaseServiceEndpoint»»Response«List«BaseService»»Response«List«ElanServiceCreationTemplate»»Response«List«ElineServiceCreationTemplate»»Response«List«L3vpnRdRtPolicy»»Response«List«L3vpnServiceCreationTemplate»»Response«List«LagServiceCreationTemplate»»Response«List«NetworkElement»»Response«List«OchServiceCreationTemplate»»Response«List«OduServiceCreationTemplate»»Response«List«PhysicalLink»»Response«List«Port»»Response«List«QosTemplate»»Response«List«Tenant»»Response«List«TunnelCreationTemplate»»Response«List«TunnelSelectionTemplate»»Response«List«User»»Response«List«string»»Response«NetworkElement»Response«NspToken»Response«OchServiceCreationTemplate»Response«OduServiceCreationTemplate»Response«PhysicalLink»Response«Port»Response«QosTemplate»Response«Tenant»Response«User»Response«boolean»Response«string»ServiceEdgeServiceTopologyStaticRouteTenantTopologyTunnelCreationTemplateTunnelSelectionTemplateUserUserInfo
readOnly (optional)
Boolean Specifies whether or not this request is read-only
endpoints (optional)
policyName (optional)
String Specifies the policy to apply to the service
tenantId (optional)
String Specifies the identifier of the tenant to which the service will be assigned. Additional Tenants may be assigned using the assign resources to tenant API
appId (optional)
String The client-defined, custom Application ID for the entity
id (optional)
String The unique identifier of the entity
appId (optional)
String The client-defined, custom Application ID for the entity
id (optional)
String The unique identifier of the entity
bidirectional (optional)
String Specifies whether a return path is required, and if so what type of return path should be determined. Unsupported for L3 VPN Services
SYMMETRIC_LOOSE
NO
ASYMMETRIC_STRICT
ASYMMETRIC_LOOSE
ANY_REVERSE_ROUTE
SYMMETRIC_STRICT
connectionState (optional)
String The connection state for the service
DISCONNECTED
CONNECTED
UNKNOWN
endpoints (optional)
maxCost (optional)
Double Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services
maxHops (optional)
Integer Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services
maxLatency (optional)
Double Specifies the maximum latency (in ms) to consider for the service. Unsupported for IP Services
name (optional)
String The name of the service
objective (optional)
String Specifies the primary goal for identifying resources and/or paths for service creation. Unsupported for L3 VPN Services
COST
DISTANCE
LATENCY
HOPS
serviceType (optional)
String The type of the service
ODU
LAG
ELAN
OCH
ELINE
L3_VPN
tenants (optional)
topology (optional)
String The logical topology of the service
appId (optional)
String The client-defined, custom Application ID for the entity
id (optional)
String The unique identifier of the entity
egressCir (optional)
Long The Egress Committed Information Rate in Kbps. Default value, no override: set to -2; Max rate available: set to -1
egressPir (optional)
Long The Egress Peak Information Rate in Kbps. Default value, no override: set to -2; Max rate available: set to -1
ingressCir (optional)
Long The Ingress Committed Information Rate in Kbps. Default value, no override: set to -2; Max rate available: set to -1
ingressPir (optional)
Long The Ingress Peak Information Rate in Kbps. Default value, no override: set to -2; Max rate available: set to -1
innerTag (optional)
Integer The inner tag. Applicable to Dot1Q or QinQ ports.
name (optional)
String The name of the service endpoint
neId (optional)
String The identifier of the network element where the service endpoint resides
neName (optional)
String The name of the network element to which this endpoint belongs
outerTag (optional)
Integer The outer tag. Applicable to Dot1Q or QinQ ports.
portId (optional)
String The identifier of the port upon which the service endpoint resides
serviceId (optional)
String The identifier of the service that uses this endpoint
bidirectional (optional)
String Specifies whether a return path is required, and if so what type of return path should be determined
SYMMETRIC_LOOSE
NO
ASYMMETRIC_STRICT
ASYMMETRIC_LOOSE
ANY_REVERSE_ROUTE
SYMMETRIC_STRICT
qosName (optional)
String Default QoS template name associated with this service
maxHops (optional)
Integer The maximum hops. The value must be greater than or equal to 0.
appId (optional)
String The client-defined custom Application ID for this object
name (optional)
String The name of the template
maxLatency (optional)
Double The maximum latency. The value must be greater than or equal to 0.
maxCost (optional)
Double The maximum cost. The value must be greater than or equal to 0.
id (optional)
String The unique identifier of the template
monitorBandwidth (optional)
Boolean Specifies whether or not the service bandwidth should be monitored
qosId (optional)
String Default QoS template ID associated with this service
objectDescription (optional)
String The description for this object
objective (optional)
String Specifies the primary goal for identifying resources and/or paths for service creation
COST
DISTANCE
LATENCY
HOPS
readOnly (optional)
Boolean Specifies whether or not this request is read-only
action (optional)
String Specifies the action to perform on the service
TRACE
DISCOVER
UPDATE
TRAVERSE
appId (optional)
String Specifies the client-defined, custom Application ID of the service
bidirectional (optional)
String Specifies whether a return path is required, and if so what type of return path should be determined. Unsupported for L3 VPN Services
SYMMETRIC_LOOSE
NO
ASYMMETRIC_STRICT
ASYMMETRIC_LOOSE
ANY_REVERSE_ROUTE
SYMMETRIC_STRICT
bw (optional)
Long Specifies the bandwidth required for the service. Unsupported for IP Services
maxCost (optional)
Double Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services
maxHops (optional)
Integer Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services
maxLatency (optional)
Double Specifies the maximum latency (in ms) to consider for the service. Unsupported for IP Services
name (optional)
String Specifies the name of the service
objective (optional)
String Specifies the primary goal for identifying resources and/or paths for service creation. Unsupported for L3 VPN Services
COST
DISTANCE
LATENCY
HOPS
reverseBW (optional)
Long Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services
serviceId (optional)
String Specifies the identifier of the service. Mandatory for a modify request.
templateId (optional)
String Specifies the identifier of the template to apply to the service. The values specified in the request will override the values defined in the template.
tenantId (optional)
String Specifies the identifier of the tenant to which the service will be assigned. Additional Tenants may be assigned using the assign resources to tenant API
endpoints (optional)
monitorBandwidth (optional)
Boolean Specifies whether or not the bandwidth utilization of the service will be monitored
appId (optional)
String The client-defined custom Application ID for this object
id (optional)
String The unique identifier of the template
name (optional)
String The name of the template
objectDescription (optional)
String The description for this object
bidirectional (optional)
String Specifies whether a return path is required, and if so what type of return path should be determined
SYMMETRIC_LOOSE
NO
ASYMMETRIC_STRICT
ASYMMETRIC_LOOSE
ANY_REVERSE_ROUTE
SYMMETRIC_STRICT
maxCost (optional)
Double The maximum cost. The value must be greater than or equal to 0.
maxHops (optional)
Integer The maximum hops. The value must be greater than or equal to 0.
maxLatency (optional)
Double The maximum latency. The value must be greater than or equal to 0.
objective (optional)
String Specifies the primary goal for identifying resources and/or paths for service creation
COST
DISTANCE
LATENCY
HOPS
monitorBandwidth (optional)
Boolean Specifies whether or not the service bandwidth should be monitored
qosId (optional)
String Default QoS template ID associated with this service
qosName (optional)
String Default QoS template name associated with this service
endpointConnectionConfig (optional)
String Specifies how the service endpoints in each of the groups are connected
detached
full_mesh
endpointId (optional)
array[String] Specifies a list of endpoints making up the grouping
groupName (optional)
String A name that identifies the grouping within a service
latitude (optional)
Double The latitude of the geographical location in degrees
longitude (optional)
Double The longitude of the geographical location in degrees
groupA (optional)
String Specifies a group upon which to terminate the connectivity
groupB (optional)
String Specifies a group upon which to terminate the connectivity
ipv4Address (optional)
ipv6Address (optional)
readOnly (optional)
Boolean Specifies whether or not this request is read-only
action (optional)
String Specifies the action to perform on the service
TRACE
DISCOVER
UPDATE
TRAVERSE
appId (optional)
String Specifies the client-defined, custom Application ID of the service
bidirectional (optional)
String Specifies whether a return path is required, and if so what type of return path should be determined. Unsupported for L3 VPN Services
SYMMETRIC_LOOSE
NO
ASYMMETRIC_STRICT
ASYMMETRIC_LOOSE
ANY_REVERSE_ROUTE
SYMMETRIC_STRICT
bw (optional)
Long Specifies the bandwidth required for the service. Unsupported for IP Services
maxCost (optional)
Double Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services
maxHops (optional)
Integer Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services
maxLatency (optional)
Double Specifies the maximum latency (in ms) to consider for the service. Unsupported for IP Services
name (optional)
String Specifies the name of the service
objective (optional)
String Specifies the primary goal for identifying resources and/or paths for service creation. Unsupported for L3 VPN Services
COST
DISTANCE
LATENCY
HOPS
reverseBW (optional)
Long Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services
serviceId (optional)
String Specifies the identifier of the service. Mandatory for a modify request.
templateId (optional)
String Specifies the identifier of the template to apply to the service. The values specified in the request will override the values defined in the template.
tenantId (optional)
String Specifies the identifier of the tenant to which the service will be assigned. Additional Tenants may be assigned using the assign resources to tenant API
topology (optional)
Topology The logical topology of a multipoint service
endpoints (optional)
readOnly (optional)
Boolean Specifies whether or not this request is read-only
action (optional)
String Specifies the action to perform on the service
TRACE
DISCOVER
UPDATE
TRAVERSE
appId (optional)
String Specifies the client-defined, custom Application ID of the service
bidirectional (optional)
String Specifies whether a return path is required, and if so what type of return path should be determined. Unsupported for L3 VPN Services
SYMMETRIC_LOOSE
NO
ASYMMETRIC_STRICT
ASYMMETRIC_LOOSE
ANY_REVERSE_ROUTE
SYMMETRIC_STRICT
bw (optional)
Long Specifies the bandwidth required for the service. Unsupported for IP Services
maxCost (optional)
Double Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services
maxHops (optional)
Integer Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services
maxLatency (optional)
Double Specifies the maximum latency (in ms) to consider for the service. Unsupported for IP Services
name (optional)
String Specifies the name of the service
objective (optional)
String Specifies the primary goal for identifying resources and/or paths for service creation. Unsupported for L3 VPN Services
COST
DISTANCE
LATENCY
HOPS
reverseBW (optional)
Long Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services
serviceId (optional)
String Specifies the identifier of the service. Mandatory for a modify request.
templateId (optional)
String Specifies the identifier of the template to apply to the service. The values specified in the request will override the values defined in the template.
tenantId (optional)
String Specifies the identifier of the tenant to which the service will be assigned. Additional Tenants may be assigned using the assign resources to tenant API
topology (optional)
Topology The logical topology of a multipoint service
autobind (optional)
String The type of autobind to be used for the service
rsvp_te
ldp
gre
encryption (optional)
Boolean Specifies whether or not Network Group Encryption is enabled for the service
endpoints (optional)
ipv4Prefix (optional)
ipv6Prefix (optional)
egressCir (optional)
Long The Egress Committed Information Rate in Kbps. Default value, no override: set to -2; Max rate available: set to -1
egressPir (optional)
Long The Egress Peak Information Rate in Kbps. Default value, no override: set to -2; Max rate available: set to -1
id (optional)
ingressCir (optional)
Long The Ingress Committed Information Rate in Kbps. Default value, no override: set to -2; Max rate available: set to -1
ingressPir (optional)
Long The Ingress Peak Information Rate in Kbps. Default value, no override: set to -2; Max rate available: set to -1
innerTag (optional)
Integer The inner tag. Applicable to Dot1Q or QinQ ports.
outerTag (optional)
Integer The outer tag. Applicable to Dot1Q or QinQ ports.
egressCir (optional)
Long The Egress Committed Information Rate in Kbps. Default value, no override: set to -2; Max rate available: set to -1
egressPir (optional)
Long The Egress Peak Information Rate in Kbps. Default value, no override: set to -2; Max rate available: set to -1
id (optional)
ingressCir (optional)
Long The Ingress Committed Information Rate in Kbps. Default value, no override: set to -2; Max rate available: set to -1
ingressPir (optional)
Long The Ingress Peak Information Rate in Kbps. Default value, no override: set to -2; Max rate available: set to -1
innerTag (optional)
Integer The inner tag. Applicable to Dot1Q or QinQ ports.
outerTag (optional)
Integer The outer tag. Applicable to Dot1Q or QinQ ports.
isHub (optional)
Boolean Specifies whether or not the service endpoint is a hub for a hub-and-spoke topology. This influences the automatic route-target and route-distinguisher generation.
name (optional)
String The name of the endpoint
primaryAddress (optional)
IpPrefix The primary IP address assigned to the service endpoint
secondaryAddresses (optional)
array[IpPrefix] A list of secondary IP addresses assigned to the service endpoint
staticRoutes (optional)
appId (optional)
String The client-defined custom Application ID for this object
id (optional)
String The unique identifier of the template
name (optional)
String The name of the template
objectDescription (optional)
String The description for this object
maxAssignedForRd (optional)
Long Maximum assigned number for route distinguisher. For type 0, the value must be between 0 and 4294967295, inclusive. For Type 2, the value must be between 0 and 65535, inclusive
maxAssignedForRt (optional)
Long Maximum assigned number for route target. For type 0, the value must be between 0 and 4294967295, inclusive. For Type 2, the value must be between 0 and 65535, inclusive
minAssignedForRd (optional)
Long Minimum assigned number for route distinguisher. For type 0, the value must be between 0 and 4294967295, inclusive. For Type 2, the value must be between 0 and 65535, inclusive
minAssignedForRt (optional)
Long Minimum assigned number for route target. For type 0, the value must be between 0 and 4294967295, inclusive. For Type 2, the value must be between 0 and 65535, inclusive
rdAS (optional)
Long Customer specified AS number for route distinguisher. For type 0, the value must be between 1 and 65535, inclusive. For Type 2, the value must be between 1 and 4294967295, inclusive
rdType (optional)
Integer Route distinguisher type, the value can be 0/1/2
rtAS (optional)
Long Customer specified AS number for route target. For type 0, the value must be between 0 and 65535, inclusive. For Type 2, the value must be between 0 and 4294967295, inclusive
rtType (optional)
Integer Route target type, the value can be 0/1/2
appId (optional)
String The client-defined custom Application ID for this object
id (optional)
String The unique identifier of the template
name (optional)
String The name of the template
objectDescription (optional)
String The description for this object
qosId (optional)
String Default QoS template ID associated with this service
qosName (optional)
String Default QoS template name associated with this service
readOnly (optional)
Boolean Specifies whether or not this request is read-only
action (optional)
String Specifies the action to perform on the service
TRACE
DISCOVER
UPDATE
TRAVERSE
appId (optional)
String Specifies the client-defined, custom Application ID of the service
bidirectional (optional)
String Specifies whether a return path is required, and if so what type of return path should be determined. Unsupported for L3 VPN Services
SYMMETRIC_LOOSE
NO
ASYMMETRIC_STRICT
ASYMMETRIC_LOOSE
ANY_REVERSE_ROUTE
SYMMETRIC_STRICT
bw (optional)
Long Specifies the bandwidth required for the service. Unsupported for IP Services
maxCost (optional)
Double Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services
maxHops (optional)
Integer Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services
maxLatency (optional)
Double Specifies the maximum latency (in ms) to consider for the service. Unsupported for IP Services
name (optional)
String Specifies the name of the service
objective (optional)
String Specifies the primary goal for identifying resources and/or paths for service creation. Unsupported for L3 VPN Services
COST
DISTANCE
LATENCY
HOPS
reverseBW (optional)
Long Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services
serviceId (optional)
String Specifies the identifier of the service. Mandatory for a modify request.
templateId (optional)
String Specifies the identifier of the template to apply to the service. The values specified in the request will override the values defined in the template.
tenantId (optional)
String Specifies the identifier of the tenant to which the service will be assigned. Additional Tenants may be assigned using the assign resources to tenant API
destinations (optional)
encryption (optional)
Boolean Specifies whether the service should be encrypted or not. The service will be rejected if no path can be found which does not support encryption.
lambda (optional)
Long Unsupported - Specifies the lambda to be used for the service
protection (optional)
Boolean Unsupported - Specifies whether a protection path should be created
regeneration (optional)
Boolean Specifies whether the service is permitted over a network element which performs optical regeneration
sources (optional)
monitorBandwidth (optional)
Boolean Specifies whether or not the bandwidth utilization of the service will be monitored
bidirectional (optional)
String Specifies whether a return path is required, and if so what type of return path should be determined
SYMMETRIC_LOOSE
NO
ASYMMETRIC_STRICT
ASYMMETRIC_LOOSE
ANY_REVERSE_ROUTE
SYMMETRIC_STRICT
maxHops (optional)
Integer The maximum hops. The value must be greater than or equal to 0.
bandwidth (optional)
Long Specifies the bandwidth required for LAG service creation
reverseBandwidth (optional)
Long Specifies the reverse bandwidth required for LAG service creation
appId (optional)
String The client-defined custom Application ID for this object
name (optional)
String The name of the template
maxLatency (optional)
Double The maximum latency. The value must be greater than or equal to 0.
maxCost (optional)
Double The maximum cost. The value must be greater than or equal to 0.
id (optional)
String The unique identifier of the template
monitorBandwidth (optional)
Boolean Specifies whether or not the service bandwidth should be monitored
objectDescription (optional)
String The description for this object
objective (optional)
String Specifies the primary goal for identifying resources and/or paths for service creation
COST
DISTANCE
LATENCY
HOPS
latency (optional)
Double The latency of the physical link in microseconds
appId (optional)
String The client-defined, custom Application ID for the entity
id (optional)
String The unique identifier of the entity
customProperties (optional)
geoLocation (optional)
ipAddress (optional)
String The IP address of the network element
location (optional)
String The name of the site where the network element is located
siteName (optional)
String The name of the network element site
expires (optional)
Long Specifies the expiry date of the token
id (optional)
String Specifies the identifier of the token
appId (optional)
String The client-defined custom Application ID for this object
id (optional)
String The unique identifier of the template
name (optional)
String The name of the template
objectDescription (optional)
String The description for this object
bidirectional (optional)
String Specifies whether a return path is required, and if so what type of return path should be determined
SYMMETRIC_LOOSE
NO
ASYMMETRIC_STRICT
ASYMMETRIC_LOOSE
ANY_REVERSE_ROUTE
SYMMETRIC_STRICT
maxCost (optional)
Double The maximum cost. The value must be greater than or equal to 0.
maxHops (optional)
Integer The maximum hops. The value must be greater than or equal to 0.
maxLatency (optional)
Double The maximum latency. The value must be greater than or equal to 0.
objective (optional)
String Specifies the primary goal for identifying resources and/or paths for service creation
COST
DISTANCE
LATENCY
HOPS
appId (optional)
String The client-defined custom Application ID for this object
id (optional)
String The unique identifier of the template
name (optional)
String The name of the template
objectDescription (optional)
String The description for this object
bidirectional (optional)
String Specifies whether a return path is required, and if so what type of return path should be determined
SYMMETRIC_LOOSE
NO
ASYMMETRIC_STRICT
ASYMMETRIC_LOOSE
ANY_REVERSE_ROUTE
SYMMETRIC_STRICT
maxCost (optional)
Double The maximum cost. The value must be greater than or equal to 0.
maxHops (optional)
Integer The maximum hops. The value must be greater than or equal to 0.
maxLatency (optional)
Double The maximum latency. The value must be greater than or equal to 0.
objective (optional)
String Specifies the primary goal for identifying resources and/or paths for service creation
COST
DISTANCE
LATENCY
HOPS
bandwidth (optional)
Long Specifies the bandwidth required for ODU creation
reverseBandwidth (optional)
Long Specifies the reverse bandwidth required for ODU creation
readOnly (optional)
Boolean Specifies whether or not this request is read-only
action (optional)
String Specifies the action to perform on the service
TRACE
DISCOVER
UPDATE
TRAVERSE
appId (optional)
String Specifies the client-defined, custom Application ID of the service
bidirectional (optional)
String Specifies whether a return path is required, and if so what type of return path should be determined. Unsupported for L3 VPN Services
SYMMETRIC_LOOSE
NO
ASYMMETRIC_STRICT
ASYMMETRIC_LOOSE
ANY_REVERSE_ROUTE
SYMMETRIC_STRICT
bw (optional)
Long Specifies the bandwidth required for the service. Unsupported for IP Services
maxCost (optional)
Double Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services
maxHops (optional)
Integer Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services
maxLatency (optional)
Double Specifies the maximum latency (in ms) to consider for the service. Unsupported for IP Services
name (optional)
String Specifies the name of the service
objective (optional)
String Specifies the primary goal for identifying resources and/or paths for service creation. Unsupported for L3 VPN Services
COST
DISTANCE
LATENCY
HOPS
reverseBW (optional)
Long Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services
serviceId (optional)
String Specifies the identifier of the service. Mandatory for a modify request.
templateId (optional)
String Specifies the identifier of the template to apply to the service. The values specified in the request will override the values defined in the template.
tenantId (optional)
String Specifies the identifier of the tenant to which the service will be assigned. Additional Tenants may be assigned using the assign resources to tenant API
destinations (optional)
encryption (optional)
Boolean Specifies whether the service should be encrypted or not. The service will be rejected if no path can be found which does not support encryption.
lambda (optional)
Long Unsupported - Specifies the lambda to be used for the service
protection (optional)
Boolean Unsupported - Specifies whether a protection path should be created
regeneration (optional)
Boolean Specifies whether the service is permitted over a network element which performs optical regeneration
sources (optional)
appId (optional)
String The client-defined, custom Application ID for the entity
id (optional)
String The unique identifier of the entity
destinationId (optional)
String The uuid of the destination network element or NNI port
linkCost (optional)
sourceId (optional)
String The uuid of the source network element or NNI port
appId (optional)
String The client-defined, custom Application ID for the entity
id (optional)
String The unique identifier of the entity
name (optional)
neId (optional)
String The router entity where the port resides
neName (optional)
String The name of the network equipment to which this endpoint belongs
portSpeed (optional)
Long The interface speed of the port
portType (optional)
egressCir (optional)
Long The Egress Committed Information Rate (CIR) in Kbps. Value can be -2 or between 0 and 100000000, inclusive. Egress CIR can not be greater than Egress PIR
egressPir (optional)
Long The Egress Peak Information Rate (PIR) in Kbps. Value can be -2, -1, or between 0 and 100000000, inclusive
appId (optional)
String The client-defined custom Application ID for this object
name (optional)
String The name of the template
id (optional)
String The unique identifier of the template
ingressCir (optional)
Long The Ingress Committed Information Rate (CIR) in Kbps. Value can be -2 or between 0 and 100000000, inclusive. Ingress CIR can not be greater than Ingress PIR
ingressPir (optional)
Long The Ingress Peak Information Rate (PIR) in Kbps. Value can be -2, -1, or between 0 and 100000000, inclusive
objectDescription (optional)
String The description for this object
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
READY
INIT
endpointAId (optional)
String Specifies an endpoint upon which to terminate the service edge
endpointBId (optional)
String Specifies an endpoint upon which to terminate the service edge
edges (optional)
endpointGrouping (optional)
groupConnections (optional)
topoName (optional)
String The name of the topology
destination (optional)
IpPrefix The prefix for the static route
routeType (optional)
String Specifies the type of static route
next_hop
targetIpAddress (optional)
IpAddress The target IP address. This would represent the next-hop address.
address (optional)
contactName (optional)
id (optional)
String The unique identifier for the tenant
phoneNumber (optional)
tenantName (optional)
serviceTopology (optional)
appId (optional)
String The client-defined custom Application ID for this object
id (optional)
String The unique identifier of the template
name (optional)
String The name of the template
objectDescription (optional)
String The description for this object
appId (optional)
String The client-defined custom Application ID for this object
id (optional)
String The unique identifier of the template
name (optional)
String The name of the template
objectDescription (optional)
String The description for this object
canCreateNewTunnel (optional)
Boolean Specifies whether or not the policy can create new tunnel
canRebindTunnel (optional)
Boolean Specifies whether or not the policy can rebind tunnel
canResizeExistingTunnel (optional)
Boolean Specifies whether or not the policy can resize an existing tunnel
canUseExistingTunnel (optional)
Boolean Specifies whether or not the policy can use an existing tunnel
id (optional)
String The user unique identifier
name (optional)
password (optional)
String The password for the user
userName (optional)