Operation
get /nbi-notification/api/v1/notifications/subscriptions
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
authorization | required | Bearer {{token}} | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
String
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Example Request Data
GET /nbi-notification/api/v1/notifications/subscriptions/09ec28a9-eb05-451d-aa37-3e4c13c889e0 HTTP/1.1 Host: {{serverIp}}:8544 Content-Type: application/json Authorization: Bearer VEtOLWFkbWluNWI4ZGFlMGMtYzE1My00NDk5LWE2NjYtM2ZhNTc5MWRmZjYw cache-control: no-cache Postman-Token: c3edc74c-d1f7-4a96-99cd-b2af89714e90
Produces
*/*
Example Response Data
{ "response": { "status": 0, "startRow": 0, "endRow": 0, "totalRows": 1, "data": { "subscriptionId": "09ec28a9-eb05-451d-aa37-3e4c13c889e0", "clientId": null, "topicId": "ns-eg-09ec28a9-eb05-451d-aa37-3e4c13c889e0", "timeOfSubscription": 1553259451623, "expiresAt": 1553263420414, "stage": "STOPPED", "persisted": true }, "errors": null } }
External Docs
Operation
post /nbi-notification/api/v1/notifications/subscriptions
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
authorization | required | Bearer {{token}} | --- |
Request body
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
String
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Example Request Data
POST /nbi-notification/api/v1/notifications/subscriptions HTTP/1.1 Host: {{serverIp}}:8544 Content-Type: application/json Authorization: Bearer VEtOLWFkbWluYmVjN2VlODAtMjg0Yi00YmJlLThiNjgtNjlkOTU4MjU3ZGMy cache-control: no-cache Postman-Token: 89ebe04a-58e5-4426-b8fe-a2594fad9415 { "categories": [ { "name": "NSP-FAULT", "propertyFilter": "severity = 'critical'" } ] }
Produces
*/*
Example Response Data
{ "response": { "status": 0, "startRow": 0, "endRow": 0, "totalRows": 1, "data": { "subscriptionId": "d96a95a9-7ba3-4ed5-a202-068413c25c5c", "clientId": null, "topicId": "ns-eg-d96a95a9-7ba3-4ed5-a202-068413c25c5c", "timeOfSubscription": 1553257279931, "expiresAt": 1553260879932, "stage": "ACTIVE", "persisted": true }, "errors": null } }
External Docs
Operation
delete /nbi-notification/api/v1/notifications/subscriptions/{subscriptionId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
authorization | required | Bearer {{token}} | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
{} | required | String |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
String
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Example Request Data
DELETE /nbi-notification/api/v1/notifications/subscriptions/09ec28a9-eb05-451d-aa37-3e4c13c889e0 HTTP/1.1 Host: {{serverIp}}:8544 Content-Type: application/json Authorization: Bearer VEtOLWFkbWluNWI4ZGFlMGMtYzE1My00NDk5LWE2NjYtM2ZhNTc5MWRmZjYw cache-control: no-cache Postman-Token: 81178a82-7852-4f27-9287-e8c7b6f5174f {}
Produces
*/*
Example Response Data
{ "response": { "status": 0, "startRow": 0, "endRow": 0, "totalRows": 1, "data": "09ec28a9-eb05-451d-aa37-3e4c13c889e0", "errors": [] } }
External Docs
Operation
get /rest-gateway/rest/api/v1/location/services/notifications
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
String
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Example Request Data
GET /rest-gateway/rest/api/v1/location/services/notifications HTTP/1.1 Host: {{serverIp}} cache-control: no-cache Postman-Token: 380efccf-039e-4b1a-91e9-32457aa4be48
Produces
*/*
Example Response Data
{ "response": { "status": 0, "startRow": 0, "endRow": 0, "totalRows": 1, "data": { "services": [ { "serviceName": "notifications", "instances": [ { "version": "v1", "docUrl": "https://{{serverIp}}:8544/nbi-notification/api-docs#!/notifications", "effectiveBaseUrl": "https://{{serverIp}}:8544/nbi-notification/api", "endpoints": [ "[GET] /v1/notifications/deletions/{taskId}", "[GET] /v1/notifications/subscriptions", "[POST] /v1/notifications/subscriptions", "[GET] /v1/notifications/subscriptions/{subscriptionId}", "[DELETE] /v1/notifications/subscriptions/{subscriptionId}", "[POST] /v1/notifications/subscriptions/{subscriptionId}/renewals" ] } ] } ] }, "errors": null } }
External Docs
Operation
get /rest-gateway/rest/api/v1/location/services
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
String
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Example Request Data
GET /rest-gateway/rest/api/v1/location/services HTTP/1.1 Host: 135.121.158.143 data ""
Produces
*/*
Example Response Data
{ "response": { "status": 0, "startRow": 0, "endRow": 0, "totalRows": 1, "data": { "services": [ { "serviceName": "samo_spanrules", "instances": [ { "version": "v2", "docUrl": "https://135.121.158.143:8443/nfm-p/api-docs?version=v2#!/samo95spanrules", "effectiveBaseUrl": "https://135.121.158.143:8443/nfm-p/rest/api", "endpoints": [ "[POST] /v2/spanrules/ServiceCreationSpanRule/findAssociatedSamUserGroups/{instanceFullName}", "[POST] /v2/spanrules/ServiceCreationSpanRule/findAssociatedSamUsers/{instanceFullName}" ] } ] }, { "serviceName": "samo_mplstp", "instances": [ { "version": "v2", "docUrl": "https://135.121.158.143:8443/nfm-p/api-docs?version=v2#!/samo95mplstp", "effectiveBaseUrl": "https://135.121.158.143:8443/nfm-p/rest/api", "endpoints": [ "[POST] /v2/mplstp/BFDTemplate/findP2PLsp/{instanceFullName}", "[POST] /v2/mplstp/GlobalTPLsp/createWithAutoFillForCompleteConnections", "[POST] /v2/mplstp/GlobalTPLsp/createWithAutoFillForIncompleteConnections" ] } ] }, ] }, "errors": null } }
External Docs
Operation
get /rest-gateway/rest/api/v1/location/services/endpoints?endPoint= /v2/mplstp/GlobalTPLsp/createWithAutoFillForCompleteConnections
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
endpoint | required | /v2/mplstp/GlobalTPLsp/createWithAutoFillForCompleteConnections | String |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
String
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Example Request Data
GET /rest-gateway/rest/api/v1/location/services/endpoints?endPoint=%20/v2/mplstp/GlobalTPLsp/createWithAutoFillForCompleteConnections Host: {{serverIp}} data ""
Produces
*/*
Example Response Data
{ "response": { "status": 0, "startRow": 0, "endRow": 0, "totalRows": 1, "data": { "endpoints": [ { "docUrl": "https://135.121.158.143:8443/nfm-p/api-docs?version=v2#!/samo95mplstp", "effectiveUrl": "https://135.121.157.103:8443/nfm-p/rest/api", "operation": "[POST]" }, { "docUrl": "https://135.121.158.143:8443/nfm-p/api-docs?version=v2#!/samo95mplstp", "effectiveUrl": "https://135.121.156.84:8443/nfm-p/rest/api", "operation": "[POST]" } ] }, "errors": null } }
External Docs
Operation
post /rest-gateway/rest/api/v1/auth/revocation
Request body
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
String
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Example Request Data
POST POST /rest-gateway/rest/api/v1/auth/revocation HTTP/1.1 Host: 135.121.158.143 Content-Type: application/json Authorization: Basic YWRtaW46Tm9raWFOc3AxIQ== data "token={{token}}&token_type_hint=token"
Produces
*/*
External Docs
Operation
get /nbi-notification/api/v1/notifications/subscriptions/{subscriptionId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
authorization | required | Bearer {{token}} | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
String
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Example Request Data
GET /nbi-notification/api/v1/notifications/subscriptions/09ec28a9-eb05-451d-aa37-3e4c13c889e0 HTTP/1.1 Host: {{serverIp}}:8544 Content-Type: application/json Authorization: Bearer VEtOLWFkbWluNWI4ZGFlMGMtYzE1My00NDk5LWE2NjYtM2ZhNTc5MWRmZjYw cache-control: no-cache Postman-Token: 7692b6eb-6e0c-4878-b26a-9fa2cee7980f
Produces
*/*
Example Response Data
{ "response": { "status": 0, "startRow": 0, "endRow": 0, "totalRows": 1, "data": { "subscriptionId": "09ec28a9-eb05-451d-aa37-3e4c13c889e0", "clientId": null, "topicId": "ns-eg-09ec28a9-eb05-451d-aa37-3e4c13c889e0", "timeOfSubscription": 1553259451623, "expiresAt": 1553263051624, "stage": "ACTIVE", "persisted": true }, "errors": null } }
External Docs
Operation
post /rest-gateway/rest/api/v1/auth/token
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
String
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Example Request Data
POST /rest-gateway/rest/api/v1/auth/token HTTP/1.1 Host: 135.121.158.143 Content-Type: application/json Authorization: Basic YWRtaW46Tm9raWFOc3AxIQ== Cache-Control: no-cache Postman-Token: ea14de89-fba4-7c60-cb9e-f3c87262fce1 { "grant_type": "client_credentials" } For Refresh Token POST /rest-gateway/rest/api/v1/auth/token HTTP/1.1 Host: 135.121.158.143 Content-Type: application/json Authorization: Basic YWRtaW46Tm9raWFOc3AxIQ== Cache-Control: no-cache Postman-Token: ea14de89-fba4-7c60-cb9e-f3c87262fce1 { "grant_type": "refresh_token", "refresh_token": "{{refresh_token}}" }
Produces
*/*
Example Response Data
{ "access_token": "VEtOLWFkbWluZDNjZjlkYTMtMzgzNi00YmJkLWIxZTctMmYzNjMxYzllNzZl", "refresh_token": "UkVUS04tYWRtaW5mN2U1YTVhZi1hYjNkLTQ0OTktODdjNi02MTNjOGFmYWVmNGQ=", "token_type": "Bearer", "expires_in": 3600 } For Refresh Token { "access_token": "VEtOLWFkbWluZDNjZjlkYTMtMzgzNi00YmJkLWIxZTctMmYzNjMxYzllZDA5", "refresh_token": "UkVUS04tYWRtaW5mN2U1YTVhZi1hYjNkLTQ0OTktODdjNi02MTNjOGFmYWVmNGQ=", "token_type": "Bearer", "expires_in": 3600 }
External Docs
Operation
post /nbi-notification/api/v1/notifications/subscriptions/{subscriptionId}/renewals
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
authorization | required | Bearer {{token}} | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
{} | required | String |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
String
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Example Request Data
POST /nbi-notification/api/v1/notifications/subscriptions/09ec28a9-eb05-451d-aa37-3e4c13c889e0/renewals HTTP/1.1 Host: {{serverIp}}:8544 Content-Type: application/json Authorization: Bearer VEtOLWFkbWluNWI4ZGFlMGMtYzE1My00NDk5LWE2NjYtM2ZhNTc5MWRmZjYw cache-control: no-cache Postman-Token: 73379dc6-5d5e-431f-822e-1f387e080f9b {}
Produces
*/*
Example Response Data
{ "response": { "status": 0, "startRow": 0, "endRow": 0, "totalRows": 1, "data": 1553263420414, "errors": null } }