{
"openapi": "3.0.0",
"info": {
"title": "Mosaic CP API Guide",
"description": "## Introduction\n\nThis guide describes the process of Operations Support System (OSS) provisioning of the ADTRAN® Mosaic Cloud Platform (Mosaic CP). An OSS consists of application(s) software that operates within a carrier’s management network and allows their systems to perform network management functions for a variety of operational support systems. This guide provides a dictionary of supported Application Programming Interface (API) commands used to complete Mosaic CP provisioning.\n\nThe Mosaic CP RESTCONF Northbound Interface (NBI) provides a programmable interface between the OSS and the associated network elements. Integration with the Mosaic CP API provides operators with a consistent and repeatable command structure across a multitude of deployment architectures.\n\nThe figure below illustrates the interactions between the OSS and Mosaic CP. The network elements will vary according to the deployment.\n\n\n\nThe main sections that make up this guide are as follows:\n\n* **Administration**: covers tasks expected to be performed by an administrator, such as how to get an API token, add/remove users, reset passwords, add device credentials, setup policies and more.\n* **Events**: covers APIs to retrieve events from the system and forward events to external systems such as a Kafka listener.\n* **Jobs**: using Mosaic CP to create, run, and check the status of jobs.\n* **Platform Details**: get the status of Mosaic CP as well as information about software versions and enabled features.\n* **Orchestration Objects**: this section covers using Mosaic CP as an SDN orchestrator.\n* **Search and Filter**: how to search for objects on the system and filter those searches based on various attributes of those objects.\n \n\n## Updates\n\n### 22.2\n\n* Added \"Job Run - Reboot Device\"\n* Deleted \"Query Interface Inspect Inventory-status\" and \"Query Device Insepct Inventory-status\" in favor of modeled inspect\n* Updated the response body for \"Run Job - Reflow Interface\"\n* Added an example request \"Run Job with Parameters - Backup Device Configuration\"\n* Added an example request \"Job Run with Parameters - Restore Device Configuration\"\n* Added an example request \"Job Run - Resynchronize NETCONF Alarms Job\"\n* Added an example request \"Run Job - Ethernet Loopback\"\n \n\n### 21.1\n\n* Added Orchestration API support for the Content Provider and Bundle Objects. This allows for these objects to be activated in a single API call without having to perform configure, deploy, activate actions.\n \n\n### 21.2\n\n* Added secure credential flag (set to false by default). To enable it, create/edit user.conf and set com.adtran.firefly.firefly-aaa.secure-credentials=true. This flag will be enabled by default in 21.3.\n* Added an additional permission called read-hidden-adtn-cld-pfrm-crdls (given to admins by default). When the secure credential flag is enabled and the user has this permission the user is able to see the password/key of an existing credential in plain text from the API. If the user does not have this permission a fixed number of asterisks will be returned for the password/key of the credential.\n \n\n### 21.4\n\n* Added support to Configure Device with IPv6 or IPv4\n* Added Modeled-Inspect support for Provisioning and Deleting Objects, and Inspecting an Interface or Device\n* Added support to Get all Compatible Model Names based on a requested model name\n \n\n### 21.5\n\n* Updated Get Users and Get All Users with user-type\n* Added Modeled-Inspect Query Depth support for Interfaces and Devices",
"contact": {},
"version": "1.0"
},
"servers": [
{
"url": "http://example.com/api/restconf",
"variables": {}
}
],
"paths": {
"/operations/adtran-auth-token:request-token": {
"post": {
"tags": [
"Token Management"
],
"summary": "Request a Session Token",
"description": "For accessing APIs in the system, there are these methods:\n\n1. Using Basic Authentication\n2. Using a Session Token\n\nThe following API command creates a session token. Subsequent requests to the system can use the obtained session token for authentication. A new token is necessary if the token expires (see below).\n\n \nRequest Payload Details\n\n\n| Attribute | Description |\n| --- | --- |\n| username | **Required:** The unique username of the user. |\n| password | **Required:** The password of the user account for which the token is to be created. |\n\n \nResponse Data Details\n\n\n| Attribute | Description |\n| --- | --- |\n| token | Obtained API token. |\n\n\n### Notes\n* Tokens are subject to an inactivity timeout which is, by default, 30 minutes. If the token is not used within the inactivity timeout period, a new token must be obtained from Mosaic CP.\n* If you do not opt for basic authentication, you will need a session token for API authentication.\n* API response times will be faster when using a session token vs basic authentication.",
"operationId": "RequestaSessionToken",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestaSessionTokenRequest"
},
"example": {
"username": "{{basic-auth-username}}",
"password": "{{basic-auth-password}}"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"access-control-allow-origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"content-length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "76"
},
"example": "76"
}
}
},
"content-type": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "application/json; charset=UTF-8"
},
"example": "application/json; charset=UTF-8"
}
}
},
"date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 05 May 2020 09:17:31 GMT"
},
"example": "Tue, 05 May 2020 09:17:31 GMT"
}
}
},
"x-frame-options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestaSessionToken-Success"
},
"example": {
"token": "832e64d6097515d558464ec0f776149645812ac8ffeaf63a04d130fadb117f91"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 05 May 2020 10:52:44 GMT"
},
"example": "Tue, 05 May 2020 10:52:44 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "159"
},
"example": "159"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/RequestaSessionToken-InvalidPassword1"
},
"example": {
"message": "Supplied username or password is incorrect. Please try again. Multiple failed login attempts may result in your account being temporarily locked."
}
}
}
}
},
"deprecated": false,
"security": []
}
},
"/operations/adtran-auth-token:release-token": {
"post": {
"tags": [
"Token Management"
],
"summary": "Release a Session Token",
"description": "Release a token so that it may no longer be used to authenticate requests.\n\n| Attribute | Description |\n| --- | --- |\n| token | **Required:** The API token to be released. |",
"operationId": "ReleaseaSessionToken",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseaSessionTokenRequest"
},
"example": {
"token": "f3302885cff780987cebfaa6be0ad283619b7a3be42df4f4546fbd47b9ae2a6b"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"access-control-allow-origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"content-length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "2"
},
"example": "2"
}
}
},
"content-type": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "application/json; charset=UTF-8"
},
"example": "application/json; charset=UTF-8"
}
}
},
"date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 05 May 2020 10:05:24 GMT"
},
"example": "Tue, 05 May 2020 10:05:24 GMT"
}
}
},
"x-frame-options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {}
},
"example": {}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-auth-config:aaa-config": {
"patch": {
"tags": [
"AAA Config"
],
"summary": "Modifying Password Security Setting",
"description": "Password Security Setting API is used by administators to modify password attributes like format, validity, etc. This function is performed by the ADMIN user.\n\n| Attribute | Description |\n| --- | --- |\n| expiration-mode | Describes how to handle the expiration date on the newly created account. Possible values : expire-now: Create the account as already expired expire-policy:Set the expiration date according to configured system policy expire-never:Create an account which will never expire Default value : expire-now|\n| password-expiry-days | Number of days after which user's password will expire. Possible values: -1Indicates that password never expires 1..180Indicate the number of days for which the password would be valid Default value : 90 days |\n| password-min-len | Minimum length of password. Possible values: 6..128 Default value: 8 |\n| password-max-len | Maximum length of password. Possible values: 6..128 Default value: 128 |\n| password-uppercase-min-len | Minimum number of upper case characters required in password. Possible values : 0..128 Default value : 1 |\n| password-min-digits | Minimum number of digits required in password. Possible values: 0..128 Default value : 1 |\n| password-min-special-char | Minimum number of special characters required in password. Possible values : 0..128 Default value: 1 |\n| password-valid-char-set | Valid character set in password. Possible values : Regular expression character set, see default as example Default value : [0-9a-zA-Z!@#$%^&*] |\n| password-history-length | \"Number of previous passwords which can not be used as a new password (0-10) . Possible values : 0..10 0 means there are no restrictions on password reuse 1 means the current password may not be reused 2 means the current password and the previous password may not be reused, and so on Default value : 5 |\n| password-history-days | Number of days a previous password can not be used as a new password. Possible values : -1 , 1…365 -1 indicates that there is no expiry for previous passwords 1 indicates that previous passwords are considered for only one day 2 indicates that previous passwords are considered for only two day and so on Default value: 180 days |\n| password-notice-days | Number of days prior to password expiration when user will be notified that his password is going to expire. Possible values : 1..30 Default value : 5 days |\n| max-failed-logins | Maximum number of consecutive times an incorrect password is allowed to be entered before the user's account will be locked. A value of 0 means that an unlimited number of failed attempts are allowed. Possible values : 1...255 attempts Default value : 5 attempts |\n| account-lock-period | Amount of time (in minutes) for which user's account gets locked. Possible values : 1...65535 minutes Default value: 5 minutes |\n| authentication-mode | The mode for user authentication in priority order. Possible values : internal, radius, tacacsplus Default value: internal|\n| authorization-mode | The mode for user authorization in priority order. Possible values : internal, radius, tacacsplus Default value: internal|\n| accounting-mode | The mode for user accounting in priority order. Possible values : internal, radius, tacacsplus Default value: internal|",
"operationId": "ModifyingPasswordSecuritySetting",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModifyingPasswordSecuritySettingRequest"
},
"example": {
"password-expiry-days": 90,
"expiration-mode": "expire-now"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"access-control-allow-origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"content-length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "0"
},
"example": "0"
}
}
},
"date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 05 May 2020 09:52:34 GMT"
},
"example": "Tue, 05 May 2020 09:52:34 GMT"
}
}
},
"x-frame-options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 05 Jan 2021 15:13:50 GMT"
},
"example": "Tue, 05 Jan 2021 15:13:50 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Vary": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
},
"example": "Accept-Encoding"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "gzip"
},
"example": "gzip"
}
}
}
},
"content": {}
},
"401": {
"description": "Unauthorized",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 08 May 2020 10:34:49 GMT"
},
"example": "Fri, 08 May 2020 10:34:49 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "45"
},
"example": "45"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/ModifyingPasswordSecuritySetting-UnauthorisedUser1"
},
"example": {
"message": "Anonymous access not authorized"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 08 May 2020 10:36:24 GMT"
},
"example": "Fri, 08 May 2020 10:36:24 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "47"
},
"example": "47"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"type": "string",
"example": "password-expiry-days must be between 1 and 180."
},
"example": "password-expiry-days must be between 1 and 180."
}
}
}
},
"deprecated": false
},
"get": {
"tags": [
"AAA Config"
],
"summary": "Retrieve Password Security Setting",
"description": "This API is used to retrieve password security settings. This function is performed by ADMIN user.\n\nFollowing table describes the attributes returned in the response.\n\n| Attribute | Description |\n| --- | --- |\n| expiration-mode | Describes how to handle the expiration date on the newly created account. Possible values : expire-now: Create the account as already expired expire-policy:Set the expiration date according to configured system policy expire-never:Create an account which will never expire Default value : expire-now|\n| password-uppercase-min-len | Minimum number of upper case characters in password. Default value: 1 Possible values: 0..128 |\n| password-history-days | Number of days a previous password can not be used as a new password. Here, -1 indicates that there is no expiry for previous passwords. 1 indicates that previous passwords are considered for only one day. 2 indicates that previous passwords are considered for only two day and so on. Default value: 180 Possible values: -1, 1..365 |\n| password-min-len | Minimum length of password. Default value: 8 Possible values:6..128 |\n| password-expiry-days | Number of days after which user's password will expire. Possible values -1Indicates that password never expires 1..180Indicate the number of days for which the password would be valid. Default value : 90 days |\n| password-max-len | Maximum length of password. Default value: 128 Possible values: 6..128 |\n| max-failed-logins | Maximum number of consecutive times an incorrect password is allowed to be entered before the user's account will be locked. A value of 0 means that an unlimited number of failed attempts are allowed. Default value: 5 Possible values: 0..128 |\n| password-min-digits | Minimum number of digits in password. Default value: 1 Possible values: 0..128 |\n| password-history-length | Number of previous passwords which can not be used as a new password (0-10). Here, 0 means there are no restrictions on password reuse. 1 means the current password may not be reused. 2 means the current password and the previous password may not be reused, and so on. Default value: 5 Possible values: 0..10 |\n| password-notice-days | Number of days prior to password expiration when user will be notified that his password is going to expire. Default value: 5 Possible values: 1..30 |\n| account-lock-period | Amount of time (in minutes) for which user's account gets locked. Default value: 5 Possible values: uint16 |\n| password-min-special-char | Minimum number of special characters in password. Default value: 1 Possible values: 0..128 |\n| password-valid-char-set | Valid character set in password. Possible values : Regular expression character set, see default as example Default value : [0-9a-zA-Z!@#$%^&*] |\n| authentication-mode | The mode for user authentication in priority order. Possible values : internal, radius, tacacsplus Default value: internal|\n| authorization-mode | The mode for user authorization in priority order. Possible values : internal, radius, tacacsplus Default value: internal|\n| accounting-mode | The mode for user accounting in priority order. Possible values : internal, radius, tacacsplus Default value: internal|",
"operationId": "RetrievePasswordSecuritySetting",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"enum": [
"application/json"
],
"type": "string",
"example": "application/json"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"access-control-allow-origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"content-length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "465"
},
"example": "465"
}
}
},
"content-type": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "application/json; charset=UTF-8"
},
"example": "application/json; charset=UTF-8"
}
}
},
"date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 05 May 2020 09:51:59 GMT"
},
"example": "Tue, 05 May 2020 09:51:59 GMT"
}
}
},
"x-frame-options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RetrievePasswordSecuritySetting-Success"
},
"example": {
"expiration-mode": "expire-now",
"password-uppercase-min-len": 1,
"password-history-days": 180,
"password-min-len": 8,
"password-expiry-days": 90,
"password-max-len": 128,
"max-failed-logins": 5,
"password-min-digits": 1,
"password-notice-days": 5,
"password-history-length": 5,
"account-lock-period": 5,
"authorization-mode": [
"internal"
],
"password-username-allowed": false,
"password-min-special-char": 1,
"password-valid-char-set": "[0-9a-zA-Z!@#$%^&*]",
"authentication-mode": [
"internal"
]
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-auth-group:groups/group=read-only": {
"post": {
"tags": [
"AAA Permission Groups"
],
"summary": "Create Group",
"description": "Create a new group by providing a unique group name and selecting permissions for the users. The name of the group is passed in via the URL and the body.\n\n| Attribute | Description |\n| --- | --- |\n| name | **Required:** A unique name of this group. |\n| permissions | A list of APIs which are permissible to this group. To see a complete list of API permissions, use the `Get Group` API call below to get the permissions for the `super-user` group. |\n| domains | A list of domains this group may access. **Deprecated**, set to empty list. |",
"operationId": "CreateGroup",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateGroupRequest"
},
"example": {
"name": "read-only",
"permissions": [
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions"
],
"domains": []
}
}
},
"required": true
},
"responses": {
"409": {
"description": "Conflict",
"headers": {
"access-control-allow-origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"content-length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "0"
},
"example": "0"
}
}
},
"date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 05 May 2020 09:42:10 GMT"
},
"example": "Tue, 05 May 2020 09:42:10 GMT"
}
}
},
"x-frame-options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {}
},
"201": {
"description": "Created",
"headers": {
"access-control-allow-origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"content-length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "0"
},
"example": "0"
}
}
},
"date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 05 May 2020 09:42:59 GMT"
},
"example": "Tue, 05 May 2020 09:42:59 GMT"
}
}
},
"x-frame-options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {}
}
},
"deprecated": false
},
"delete": {
"tags": [
"AAA Permission Groups"
],
"summary": "Delete Group",
"description": "Delete an existing group by providing the group name by providing the group name in the URL parameter.",
"operationId": "DeleteGroup",
"parameters": [],
"responses": {
"404": {
"description": "Not Found",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Mon, 11 May 2020 11:36:52 GMT"
},
"example": "Mon, 11 May 2020 11:36:52 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "0"
},
"example": "0"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {}
},
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Mon, 11 May 2020 10:01:10 GMT"
},
"example": "Mon, 11 May 2020 10:01:10 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "0"
},
"example": "0"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {}
}
},
"deprecated": false
}
},
"/data/adtran-auth-group:groups/group=none": {
"get": {
"tags": [
"AAA Permission Groups"
],
"summary": "Get Group",
"description": "This API is used to retrieve a given user group and their associated permissions.\n\n| Attribute | Description |\n| --- | --- |\n| domains | A list of domains this group may access. |\n| name | The unique name of this group. |\n| permissions | A list of APIs which are permissible to this group. |",
"operationId": "GetGroup",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"enum": [
"application/json"
],
"type": "string",
"example": "application/json"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"access-control-allow-origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"content-length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "117"
},
"example": "117"
}
}
},
"content-type": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "application/json; charset=UTF-8"
},
"example": "application/json; charset=UTF-8"
}
}
},
"date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 05 May 2020 10:08:38 GMT"
},
"example": "Tue, 05 May 2020 10:08:38 GMT"
}
}
},
"x-frame-options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetGroup-Success"
},
"example": {
"domains": [],
"name": "read-only-user",
"permissions": [
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions"
]
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 05 Jan 2021 16:26:20 GMT"
},
"example": "Tue, 05 Jan 2021 16:26:20 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Vary": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
},
"example": "Accept-Encoding"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "gzip"
},
"example": "gzip"
}
}
}
},
"content": {}
}
},
"deprecated": false
}
},
"/data/adtran-auth-group:groups": {
"get": {
"tags": [
"AAA Permission Groups"
],
"summary": "Get All Groups",
"description": "This API is used to retrieve a list of user groups and their associated permissions.\n\n| Attribute | Description |\n| --- | --- |\n| domains | A list of domains this group may access. |\n| name | The unique name of this group. |\n| permissions | A list of APIs which are permissible to this group. |",
"operationId": "GetAllGroups",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"enum": [
"application/json"
],
"type": "string",
"example": "application/json"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 05 Jan 2021 16:28:21 GMT"
},
"example": "Tue, 05 Jan 2021 16:28:21 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Vary": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
},
"example": "Accept-Encoding"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "gzip"
},
"example": "gzip"
}
}
}
},
"content": {
"application/json;charset=utf-8": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetAllGroups-Success"
},
"description": "",
"example": [
{
"domains": [],
"name": "activate-device-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow-devices:read-uiworkflow-devices",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-auth-permission:all",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-cloud-platform-management-domains:read-adtn-cld-pfrm-md",
"adtran-cloud-platform-profiles:read-profile",
"adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interfaces",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domain-types",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domains",
"adtran-cloud-platform-uiworkflow-part-numbers:read-uiworkflow-part-number",
"adtran-cloud-platform-uiworkflow-profiles:read-profile"
]
},
{
"domains": [],
"name": "activate-interface-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interfaces",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-auth-permission:all",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-profiles:read-profile",
"adtran-cloud-platform-uiworkflow-bundles:read-uiworkflow-bundles",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-cloud-platform-uiworkflow-devices:read-uiworkflow-devices",
"adtran-cloud-platform-uiworkflow-interfaces:filter-uiworkflow-interface-resources",
"adtran-cloud-platform-uiworkflow-interfaces:filter-uiworkflow-physical-resources",
"adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interface-type",
"adtran-cloud-platform-uiworkflow-profiles:read-profile"
]
},
{
"domains": [],
"name": "activate-job-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow-jobs:read-job",
"adtran-cloud-platform-jobs:read-adtn-cld-pfrm-job",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-profiles:read-profile",
"adtran-cloud-platform-uiworkflow-devices:read-uiworkflow-devices",
"adtran-cloud-platform-uiworkflow-jobs:get-job-context",
"adtran-cloud-platform-uiworkflow-jobs:read-action",
"adtran-cloud-platform-uiworkflow-jobs:read-trigger",
"adtran-cloud-platform-uiworkflow-profiles:read-profile"
]
},
{
"domains": [],
"name": "activate-management-domain-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domains",
"adtran-cloud-platform-management-domains:read-adtn-cld-pfrm-md",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-auth-permission:all",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domain-types"
]
},
{
"domains": [],
"name": "activate-profile-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-auth-permission:all",
"adtran-cloud-platform-profiles:config-profile",
"adtran-cloud-platform-hardware:read-profile",
"adtran-yang-datastore:read-yang-model",
"adtran-yang-datastore:write-yang-model"
]
},
{
"domains": [],
"name": "activate-profile-vector-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow-profiles:read-profile",
"adtran-cloud-platform-profiles:read-profile",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-labels:read-labels",
"adtran-yang-datastore:read-yang-model",
"adtran-yang-datastore:write-yang-model",
"adtran-cloud-platform-profiles:config-profile",
"adtran-auth-permission:all",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-content-providers",
"adtran-cloud-platform-uiworkflow-bundles:read-uiworkflow-bundles",
"adtran-cloud-platform-servers:read-adtn-cld-pfrm-srvr",
"adtran-cloud-platform-profiles:config-profile"
]
},
{
"domains": [],
"name": "activate-provider-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-content-providers",
"adtran-captive-portal-content-providers:read-content-provider",
"adtran-auth-permission:all"
]
},
{
"domains": [],
"name": "activate-server-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow-servers:read-uiworkflow-servers",
"adtran-cloud-platform-servers:read-adtn-cld-pfrm-srvr",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-auth-permission:all"
]
},
{
"domains": [],
"name": "activate-service-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-captive-portal-services:activate-service",
"adtran-captive-portal-services:deactivate-service",
"adtran-captive-portal-service-transition:read-service-transitions",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-services",
"adtran-cloud-platform-services:read-service",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-catalog",
"adtran-auth-permission:all",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-yang-datastore:read-yang-model",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-content-providers",
"adtran-cloud-platform-labels:read-labels"
]
},
{
"domains": [],
"name": "activate-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow-devices:read-uiworkflow-devices",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interfaces",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-cloud-platform-uiworkflow-jobs:read-job",
"adtran-cloud-platform-jobs:read-adtn-cld-pfrm-job",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domains",
"adtran-cloud-platform-management-domains:read-adtn-cld-pfrm-md",
"adtran-cloud-platform-uiworkflow-servers:read-uiworkflow-servers",
"adtran-cloud-platform-servers:read-adtn-cld-pfrm-srvr",
"adtran-captive-portal-services:activate-service",
"adtran-captive-portal-services:deactivate-service",
"adtran-captive-portal-service-transition:read-service-transitions",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-services",
"adtran-cloud-platform-services:read-service",
"adtran-cloud-platform-uiworkflow-profiles:read-profile",
"adtran-cloud-platform-profiles:read-profile",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-content-providers",
"adtran-captive-portal-content-providers:read-content-provider",
"adtran-cloud-platform-labels:read-labels"
]
},
{
"domains": [],
"name": "audit-log-admin",
"permissions": [
"adtran-auth-accounting:read-accounting-logs"
]
},
{
"domains": [],
"name": "configure-device-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow-devices:read-uiworkflow-devices",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-configure",
"adtran-cloud-platform-uiworkflow-part-numbers:read-uiworkflow-part-number",
"adtran-cloud-platform-uiworkflow-profiles:read-profile",
"adtran-cloud-platform-profiles:read-profile",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domain-types",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domains",
"adtran-cloud-platform-management-domains:read-adtn-cld-pfrm-md",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-auth-permission:all",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interfaces",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete"
]
},
{
"domains": [],
"name": "configure-interface-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interface-type",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-configure",
"adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interfaces",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-cloud-platform-uiworkflow-profiles:read-profile",
"adtran-cloud-platform-profiles:read-profile",
"adtran-auth-permission:all",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-uiworkflow-bundles:read-uiworkflow-bundles",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-cloud-platform-uiworkflow-devices:read-uiworkflow-devices",
"adtran-cloud-platform-uiworkflow-interfaces:filter-uiworkflow-interface-resources",
"adtran-cloud-platform-uiworkflow-interfaces:filter-uiworkflow-physical-resources",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete"
]
},
{
"domains": [],
"name": "configure-job-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-configure",
"adtran-cloud-platform-uiworkflow-jobs:read-job",
"adtran-cloud-platform-jobs:read-adtn-cld-pfrm-job",
"adtran-cloud-platform-uiworkflow-jobs:read-action",
"adtran-cloud-platform-uiworkflow-jobs:read-trigger",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-profiles:read-profile",
"adtran-cloud-platform-uiworkflow-devices:read-uiworkflow-devices",
"adtran-cloud-platform-uiworkflow-jobs:get-job-context",
"adtran-cloud-platform-uiworkflow-profiles:read-profile",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete"
]
},
{
"domains": [],
"name": "configure-management-domain-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-configure",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domain-types",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domains",
"adtran-cloud-platform-management-domains:read-adtn-cld-pfrm-md",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-auth-permission:all",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete"
]
},
{
"domains": [],
"name": "configure-profile-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-configure",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-auth-permission:all",
"adtran-cloud-platform-profiles:config-profile",
"adtran-cloud-platform-hardware:read-profile",
"adtran-yang-datastore:read-yang-model",
"adtran-yang-datastore:write-yang-model"
]
},
{
"domains": [],
"name": "configure-profile-vector-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-configure",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-content-providers",
"adtran-captive-portal-content-providers:read-content-provider",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-auth-permission:all",
"adtran-cloud-platform-profiles:config-profile",
"adtran-cloud-platform-hardware:read-profile",
"adtran-yang-datastore:read-yang-model",
"adtran-yang-datastore:write-yang-model"
]
},
{
"domains": [],
"name": "configure-provider-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-configure",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-content-providers",
"adtran-captive-portal-content-providers:read-content-provider",
"adtran-auth-permission:all",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions"
]
},
{
"domains": [],
"name": "configure-server-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-configure",
"adtran-cloud-platform-uiworkflow-servers:read-uiworkflow-servers",
"adtran-cloud-platform-servers:read-adtn-cld-pfrm-srvr",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-auth-permission:all"
]
},
{
"domains": [],
"name": "configure-service-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-service-profiles",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-services",
"adtran-cloud-platform-services:modify-service",
"adtran-cloud-platform-services:read-service",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-catalog",
"adtran-auth-permission:all",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-configure",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-yang-datastore:read-yang-model",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-content-providers",
"adtran-cloud-platform-labels:read-labels"
]
},
{
"domains": [],
"name": "deploy-device-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow-devices:read-uiworkflow-devices",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-undeploy",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interfaces",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-auth-permission:all",
"adtran-cloud-platform-profiles:read-profile",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-management-domains:read-adtn-cld-pfrm-md",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domain-types",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domains",
"adtran-cloud-platform-uiworkflow-part-numbers:read-uiworkflow-part-number",
"adtran-cloud-platform-uiworkflow-profiles:read-profile"
]
},
{
"domains": [],
"name": "deploy-interface-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interfaces",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-cloud-platform-uiworkflow-devices:read-uiworkflow-devices",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-uiworkflow-interfaces:filter-uiworkflow-interface-resources",
"adtran-cloud-platform-uiworkflow-interfaces:filter-uiworkflow-physical-resources",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-undeploy",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow-bundles:read-uiworkflow-bundles",
"adtran-auth-permission:all",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-profiles:read-profile",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interface-type",
"adtran-cloud-platform-uiworkflow-profiles:read-profile"
]
},
{
"domains": [],
"name": "deploy-job-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow-jobs:read-job",
"adtran-cloud-platform-jobs:read-adtn-cld-pfrm-job",
"adtran-cloud-platform-uiworkflow-devices:read-uiworkflow-devices",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-uiworkflow-profiles:read-profile",
"adtran-cloud-platform-profiles:read-profile",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-undeploy",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow-jobs:get-job-context",
"adtran-cloud-platform-uiworkflow-jobs:read-action",
"adtran-cloud-platform-uiworkflow-jobs:read-trigger"
]
},
{
"domains": [],
"name": "deploy-management-domain-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domains",
"adtran-cloud-platform-management-domains:read-adtn-cld-pfrm-md",
"adtran-cloud-platform-uiworkflow-servers:read-uiworkflow-servers",
"adtran-cloud-platform-servers:read-adtn-cld-pfrm-srvr",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-undeploy",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-auth-permission:all",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domain-types"
]
},
{
"domains": [],
"name": "deploy-profile-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-undeploy",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-auth-permission:all",
"adtran-cloud-platform-profiles:config-profile",
"adtran-cloud-platform-hardware:read-profile",
"adtran-yang-datastore:read-yang-model",
"adtran-yang-datastore:write-yang-model"
]
},
{
"domains": [],
"name": "deploy-profile-vector-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow-profiles:read-profile",
"adtran-cloud-platform-profiles:read-profile",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-undeploy",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-auth-permission:all",
"adtran-yang-datastore:read-yang-model",
"adtran-yang-datastore:write-yang-model"
]
},
{
"domains": [],
"name": "deploy-provider-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-content-providers",
"adtran-captive-portal-content-providers:read-content-provider",
"adtran-cloud-platform-uiworkflow-devices:read-uiworkflow-devices",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-undeploy",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-auth-permission:all"
]
},
{
"domains": [],
"name": "deploy-server-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow-servers:read-uiworkflow-servers",
"adtran-cloud-platform-servers:read-adtn-cld-pfrm-srvr",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-undeploy",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-auth-permission:all"
]
},
{
"domains": [],
"name": "deploy-service-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-services",
"adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interfaces",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-content-providers",
"adtran-captive-portal-content-providers:read-content-provider",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-undeploy",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-services:read-service",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-catalog",
"adtran-auth-permission:all",
"adtran-yang-datastore:read-yang-model",
"adtran-cloud-platform-labels:read-labels"
]
},
{
"domains": [],
"name": "edit-device-user",
"permissions": [
"adtran-auth-permission:all",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-management-domains:read-adtn-cld-pfrm-md",
"adtran-cloud-platform-profiles:read-profile",
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-cloud-platform-uiworkflow-devices:read-uiworkflow-devices",
"adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interfaces",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domain-types",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domains",
"adtran-cloud-platform-uiworkflow-part-numbers:read-uiworkflow-part-number",
"adtran-cloud-platform-uiworkflow-profiles:read-profile",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-configure",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-undeploy"
]
},
{
"domains": [],
"name": "edit-interface-user",
"permissions": [
"adtran-auth-permission:all",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-profiles:read-profile",
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow-bundles:read-uiworkflow-bundles",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-cloud-platform-uiworkflow-devices:read-uiworkflow-devices",
"adtran-cloud-platform-uiworkflow-interfaces:filter-uiworkflow-interface-resources",
"adtran-cloud-platform-uiworkflow-interfaces:filter-uiworkflow-physical-resources",
"adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interface-type",
"adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interfaces",
"adtran-cloud-platform-uiworkflow-profiles:read-profile",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-configure",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-undeploy"
]
},
{
"domains": [],
"name": "edit-job-user",
"permissions": [
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-jobs:read-adtn-cld-pfrm-job",
"adtran-cloud-platform-jobs:modify-adtn-cld-pfrm-job",
"adtran-cloud-platform-profiles:read-profile",
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow-devices:read-uiworkflow-devices",
"adtran-cloud-platform-uiworkflow-jobs:get-job-context",
"adtran-cloud-platform-uiworkflow-jobs:read-action",
"adtran-cloud-platform-uiworkflow-jobs:read-job",
"adtran-cloud-platform-uiworkflow-jobs:read-trigger",
"adtran-cloud-platform-uiworkflow-profiles:read-profile",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-configure",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-undeploy"
]
},
{
"domains": [],
"name": "edit-management-domain-user",
"permissions": [
"adtran-auth-permission:all",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-management-domains:read-adtn-cld-pfrm-md",
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-servers:read-adtn-cld-pfrm-srvr",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domain-types",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domains",
"adtran-cloud-platform-uiworkflow-servers:read-uiworkflow-servers",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-configure",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-undeploy"
]
},
{
"domains": [],
"name": "edit-profile-user",
"permissions": [
"adtran-auth-permission:all",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-management-domains:read-adtn-cld-pfrm-md",
"adtran-cloud-platform-profiles:read-profile",
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-cloud-platform-uiworkflow-profiles:read-profile",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-configure",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-undeploy",
"adtran-cloud-platform-profiles:config-profile",
"adtran-yang-datastore:read-yang-model",
"adtran-yang-datastore:write-yang-model"
]
},
{
"domains": [],
"name": "edit-profile-vector-user",
"permissions": [
"adtran-auth-permission:all",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-management-domains:read-adtn-cld-pfrm-md",
"adtran-cloud-platform-profiles:read-profile",
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-cloud-platform-uiworkflow-profiles:read-profile",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-configure",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-undeploy",
"adtran-cloud-platform-servers:read-adtn-cld-pfrm-srvr",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-content-providers",
"adtran-cloud-platform-uiworkflow-bundles:read-uiworkflow-bundles",
"adtran-cloud-platform-profiles:config-profile",
"adtran-yang-datastore:read-yang-model",
"adtran-yang-datastore:write-yang-model"
]
},
{
"domains": [],
"name": "edit-provider-user",
"permissions": [
"adtran-auth-permission:all",
"adtran-captive-portal-content-providers:read-content-provider",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow-devices:read-uiworkflow-devices",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-content-providers",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-configure",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-undeploy"
]
},
{
"domains": [],
"name": "edit-server-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-configure",
"adtran-cloud-platform-uiworkflow-servers:read-uiworkflow-servers",
"adtran-cloud-platform-servers:read-adtn-cld-pfrm-srvr",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-auth-permission:all",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-undeploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate"
]
},
{
"domains": [],
"name": "edit-service-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-captive-portal-services:activate-service",
"adtran-captive-portal-services:deactivate-service",
"adtran-captive-portal-service-transition:read-service-transitions",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-services",
"adtran-cloud-platform-services:read-service",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-catalog",
"adtran-auth-permission:all",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-yang-datastore:read-yang-model",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-service-profiles",
"adtran-cloud-platform-services:modify-service",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-configure",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete",
"adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interfaces",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-content-providers",
"adtran-captive-portal-content-providers:read-content-provider",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-undeploy",
"adtran-cloud-platform-labels:read-labels"
]
},
{
"domains": [],
"name": "edit-ui-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-configure",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-content-providers",
"adtran-captive-portal-content-providers:read-content-provider",
"adtran-cloud-platform-uiworkflow-devices:read-uiworkflow-devices",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-uiworkflow-servers:read-uiworkflow-servers",
"adtran-cloud-platform-servers:read-adtn-cld-pfrm-srvr",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-undeploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-service-profiles",
"adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interfaces",
"adtran-cloud-platform-uiworkflow-interfaces:filter-uiworkflow-physical-resources",
"adtran-cloud-platform-uiworkflow-bundles:read-uiworkflow-bundles",
"adtran-auth-permission:all",
"adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interface-type",
"adtran-cloud-platform-uiworkflow-profiles:read-profile",
"adtran-cloud-platform-profiles:read-profile",
"adtran-cloud-platform-bundles:read-adtn-cld-pfrm-bndl",
"adtran-cloud-platform-data-centers:read-adtn-cld-pfrm-data-ctr",
"adtran-captive-portal-service-transition:read-service-transitions",
"adtran-captive-portal-services:activate-service",
"adtran-captive-portal-services:deactivate-service",
"adtran-cloud-platform-hardware:read-profile",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-labels:modify-labels",
"adtran-cloud-platform-management-domains:read-adtn-cld-pfrm-md",
"adtran-cloud-platform-profiles:config-profile",
"adtran-cloud-platform-services:modify-service",
"adtran-cloud-platform-services:read-service",
"adtran-cloud-platform-uiworkflow-bundles:read-uiworkflow-bundle-type",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-cloud-platform-uiworkflow-interfaces:filter-uiworkflow-interface-resources",
"adtran-cloud-platform-uiworkflow-jobs:get-job-context",
"adtran-cloud-platform-uiworkflow-jobs:read-action",
"adtran-cloud-platform-uiworkflow-jobs:read-job",
"adtran-cloud-platform-uiworkflow-jobs:read-trigger",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domain-types",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domains",
"adtran-cloud-platform-uiworkflow-part-numbers:read-uiworkflow-part-number",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-services",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-catalog",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete",
"adtran-yang-datastore:read-yang-model",
"adtran-yang-datastore:write-yang-model",
"adtran-cloud-platform-ui-inspect:run-request",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev-inspect",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int-inspect",
"adtran-cloud-platform-jobs:read-adtn-cld-pfrm-job"
]
},
{
"domains": [],
"name": "events-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-event-workflow:event-read"
]
},
{
"domains": [],
"name": "group-permissions-admin",
"permissions": [
"adtran-auth-group:modify-groups",
"adtran-auth-permission:all"
]
},
{
"domains": [],
"name": "groups-admin",
"permissions": [
"adtran-auth-group:modify-groups",
"adtran-auth-permission:all"
]
},
{
"domains": [],
"name": "inspect-ui-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-ui-inspect:run-request",
"adtran-cloud-platform-uiworkflow-devices:read-uiworkflow-devices",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev-inspect",
"adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interfaces",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int-inspect",
"adtran-cloud-platform-uiworkflow-servers:read-uiworkflow-servers",
"adtran-cloud-platform-servers:read-adtn-cld-pfrm-srvr",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-services",
"adtran-cloud-platform-services:read-service",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-content-providers",
"adtran-captive-portal-content-providers:read-content-provider",
"adtran-cloud-platform-uiworkflow-jobs:read-job",
"adtran-cloud-platform-jobs:read-adtn-cld-pfrm-job",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domains",
"adtran-cloud-platform-management-domains:read-adtn-cld-pfrm-md",
"adtran-cloud-platform-uiworkflow-profiles:read-profile",
"adtran-cloud-platform-profiles:read-profile",
"adtran-cloud-platform-labels:read-labels"
]
},
{
"domains": [],
"name": "login-banner-admin",
"permissions": [
"adtran-launchpad-login:modify-login-page",
"adtran-launchpad-login:modify-browser-page",
"adtran-cloud-platform-settings:read-adtn-cld-pfrm-set",
"adtran-cloud-platform-settings:modify-adtn-cld-pfrm-set",
"adtran-auth-permission:anonymous"
]
},
{
"domains": [],
"name": "mosaic-user",
"permissions": [
"adtran-auth-permission:all",
"adtran-ffui-workboards:modify-workboards",
"adtran-ffui-workboards:read-workboards",
"adtran-ffui-applications:read-apps-info",
"adtran-ffui-applications:write-apps-info",
"adtran-cloud-platform-information:read-information",
"adtran-cloud-platform-plugin:get-plugins"
]
},
{
"domains": [],
"name": "super-user",
"permissions": [
"adtran-cloud-platform-uiworkflow:run-uiworkflow-configure",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-suspend-resume",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-undeploy",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-catalog",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-onboard-device",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:force-delete",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-notify",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deploy",
"adtran-auth-permission:all",
"adtran-auth-permission:anonymous",
"adtran-export-data-service:export-data-service",
"adtran-cloud-platform-topics:configure-topics",
"adtran-cloud-platform-topics:read-topics",
"adtran-cloud-platform-jobs:read-adtn-cld-pfrm-job",
"adtran-cloud-platform-jobs:modify-adtn-cld-pfrm-job",
"adtran-cloud-platform-software-upgrade-service:download-software",
"adtran-cloud-platform-software-upgrade-service:commit-software",
"adtran-cloud-platform-software-upgrade-service:reboot-device",
"adtran-cloud-platform-software-upgrade-service:commit-and-activate-software",
"adtran-cloud-platform-software-upgrade-service:activate-software",
"adtran-ffui-settings:modify-settings",
"adtran-ffui-settings:read-settings",
"adtran-cloud-platform-server-coordination:communicate-servers",
"adtran-cloud-platform-server-coordination:activate-servers",
"adtran-cloud-platform-server-coordination:delete-servers",
"adtran-cloud-platform-server-coordination:config-servers",
"adtran-cloud-platform-server-coordination:undeploy-servers",
"adtran-cloud-platform-server-coordination:deploy-servers",
"adtran-cloud-platform-server-coordination:deactivate-servers",
"adtran-auth-tech-support:generate-tech-support-challenges",
"adtran-auth-domain:modify-domains",
"adtran-cloud-platform-uiworkflow-topology:run-uiworkflow-topology",
"adtran-cloud-platform-uiworkflow-topology:read-uiworkflow-topology",
"adtran-cloud-platform-management-domains:modify-adtn-cld-pfrm-md",
"adtran-cloud-platform-management-domains:read-adtn-cld-pfrm-md",
"adtran-cloud-platform-elasticsearch-rollover-indices:rollover-cron-update",
"adtran-cloud-platform-elasticsearch-rollover-indices:read-adtn-cld-pfrm-es-rlvr-indcs",
"adtran-cloud-platform-elasticsearch-rollover-indices:modify-adtn-cld-pfrm-es-rlvr-indcs",
"adtran-nms-inventory:read-inventory",
"adtran-captive-portal-policers:modify-policer",
"adtran-captive-portal-policers:read-policer",
"adtran-ffui-workboards-yds:modify-workboards",
"adtran-ffui-workboards-yds:read-workboards",
"adtran-cloud-platform-event-workflow:event-clear",
"adtran-cloud-platform-event-workflow:event-read",
"adtran-cloud-platform-event-workflow:event-write",
"adtran-cloud-platform-event-workflow:read-event-workflow-transitions",
"adtran-cloud-platform-hardware:read-profile",
"adtran-yang-datastore:write-yang-model",
"adtran-yang-datastore:read-yang-model",
"adtran-vssm-gx-subscriber-data:read-subscriber-data",
"adtran-cloud-platform-dhcp-config:dhcp-config",
"adtran-cloud-platform-uiworkflow-jobs:read-action",
"adtran-cloud-platform-uiworkflow-jobs:read-run-job-transitions",
"adtran-cloud-platform-uiworkflow-jobs:run-job-with-parameters",
"adtran-cloud-platform-uiworkflow-jobs:get-job-context",
"adtran-cloud-platform-uiworkflow-jobs:run-job",
"adtran-cloud-platform-uiworkflow-jobs:read-job",
"adtran-cloud-platform-uiworkflow-jobs:read-trigger",
"adtran-cloud-platform-services:read-service",
"adtran-cloud-platform-services:modify-service",
"adtran-cloud-platform-software-upgrade-maintenance-service:get-upgrade-summary-status",
"adtran-cloud-platform-software-upgrade-maintenance-service:initiate-upgrade",
"adtran-cloud-platform-software-upgrade-maintenance-service:get-upgrade-status",
"adtran-cloud-platform-dhcp-subscriber-profile-mapping:modify-subscriber-profile-mapping",
"adtran-cloud-platform-dhcp-subscriber-profile-mapping:read-subscriber-profile-mapping",
"adtran-cloud-platform-profiles-pools:read-profile-pool",
"adtran-cloud-platform-profiles-pools:modify-profile-pools",
"adtran-cloud-platform-y1731-session-measurement-report:read-report",
"adtran-auth-user:modify-users",
"adtran-auth-user:administer-users",
"adtran-cloud-platform-bundles:read-adtn-cld-pfrm-bndl",
"adtran-cloud-platform-bundles:modify-adtn-cld-pfrm-bndl",
"adtran-cloud-platform-service-test-rfc2544:run-test-rfc2544",
"adtran-cloud-platform-service-test-rfc2544:read-rfc2544-tests",
"adtran-vssm-gx-handler:gx-handler",
"adtran-cloud-platform-deferred-intents:read-deferred-intents",
"adtran-cloud-platform-servers:modify-adtn-cld-pfrm-srvr",
"adtran-cloud-platform-servers:read-adtn-cld-pfrm-srvr",
"adtran-cloud-platform-data-centers:modify-adtn-cld-pfrm-data-ctr",
"adtran-cloud-platform-data-centers:read-adtn-cld-pfrm-data-ctr",
"adtran-dhcp-autoprov-info:read-adtn-dhcp-ap-info",
"adtran-cloud-platform-business-service-management:service-write",
"adtran-cloud-platform-business-service-management:service-read",
"adtran-cloud-platform-orchestration:read-orchestration-transitions",
"adtran-cloud-platform-orchestration:run-orchestration-create",
"adtran-cloud-platform-orchestration:run-orchestration-modify",
"adtran-cloud-platform-orchestration:run-orchestration-delete",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-auth-config:modify-config",
"adtran-cloud-platform-uiworkflow-servers:read-uiworkflow-servers",
"adtran-cloud-platform-search:administer-search",
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-job-manager:modify-adtn-cld-pfrm-job-mngr",
"adtran-cloud-platform-job-manager:read-adtn-cld-pfrm-job-mngr",
"adtran-manifests:read-adtn-manif",
"adtran-cloud-platform-vssm-diameter-statistics:diameter-stats-perm",
"adtran-captive-portal-sla-profiles:modify-sla-profile",
"adtran-captive-portal-sla-profiles:read-sla-profile",
"adtran-cloud-platform-uiworkflow-data-center-types:read-uiworkflow-data-center-type",
"adtran-cloud-platform-diagnostic-data-maintenance-service:get-diagnostic-job-info",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domain-types",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domains",
"adtran-auth-config-external:modify-config-ext",
"adtran-cloud-platform-uiworkflow-subscribers:read-uiworkflow-subscribers",
"adtran-cloud-platform-uiworkflow-subscribers:filter-uiworkflow-subscriber-resources",
"adtran-auth-accounting:read-accounting-logs",
"adtran-cloud-platform-subscriber-policy:read-subs-policy",
"adtran-cloud-platform-subscriber-policy:modify-subs-policy",
"adtran-captive-portal-content-providers:read-content-provider",
"adtran-captive-portal-content-providers:modify-content-provider",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-devices:modify-adtn-cld-pfrm-dev",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev-inspect",
"adtran-nbi-pm:pm-config",
"adtran-nbi-pm:pm-read",
"adtran-cloud-platform-subscribers:read-adtn-cld-pfrm-subs",
"adtran-cloud-platform-subscribers:modify-adtn-cld-pfrm-subs",
"adtran-cloud-platform-profiles:config-profile",
"adtran-cloud-platform-profiles:read-profile",
"adtran-cloud-platform-ui-inspect:run-request",
"adtran-cloud-platform-ui-inspect:run-action",
"adtran-cloud-platform-alarm-logger:read-alarm-logs",
"adtran-server-proxy-by-name:server-read",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-labels:modify-labels",
"adtran-cloud-platform-event-description:configure-event-description",
"adtran-cloud-platform-event-description:read-event-description",
"adtran-cloud-platform-proxy-service:server-read",
"adtran-cloud-platform-proxy-service:server-write",
"adtran-cloud-platform-proxy-service:mount-point-read",
"adtran-cloud-platform-proxy-service:device-read",
"adtran-cloud-platform-proxy-service:device-write",
"adtran-cloud-platform-plugin:get-plugins",
"adtran-cloud-platform-plugin:reload-plugins",
"adtran-cloud-platform-information:read-information",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int-inspect",
"adtran-cloud-platform-interfaces:modify-adtn-cld-pfrm-int",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interface-type",
"adtran-cloud-platform-uiworkflow-interfaces:filter-uiworkflow-interface-resources",
"adtran-cloud-platform-uiworkflow-interfaces:filter-uiworkflow-physical-resources",
"adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interfaces",
"adtran-cloud-platform-connection-monitor:aggregate-sessions-count",
"adtran-cloud-platform-system-monitor:read-system-monitor-node-status",
"adtran-cloud-platform-dfn-route-configuration:read-dfn-rt-configuration",
"adtran-cloud-platform-dfn-route-configuration:modify-dfn-rt-configuration",
"adtran-cloud-platform-uiworkflow-inspect:inspect-uiworkflow-profiles",
"adtran-cloud-platform-uiworkflow-inspect:inspect-uiworkflow-server",
"adtran-cloud-platform-uiworkflow-inspect:manage-uiworkflow-dpu",
"adtran-cloud-platform-uiworkflow-inspect:inspect-uiworkflow-devices",
"adtran-cloud-platform-uiworkflow-inspect:inspect-uiworkflow-interfaces",
"adtran-cloud-platform-uiworkflow-devices:read-uiworkflow-devices",
"adtran-cloud-platform-uiworkflow-behaviors:read-uiworkflow-behavior",
"adtran-cloud-platform-uiworkflow-behaviors:run-uiworkflow-behavior",
"adtran-cloud-platform-base-configurations:modify-adtn-cld-pfrm-bc",
"adtran-cloud-platform-base-configurations:read-adtn-cld-pfrm-bc",
"adtran-captive-portal-wholesale-helpers:remove-ont",
"adtran-captive-portal-wholesale-helpers:delete-ses-service",
"adtran-captive-portal-wholesale-helpers:decommission-l2s-device",
"adtran-captive-portal-wholesale-helpers:delete-dpu-mgmt-svcs-for-l2s",
"adtran-captive-portal-wholesale-helpers:decommission-dpu",
"adtran-captive-portal-wholesale-helpers:create-content-provider",
"adtran-captive-portal-wholesale-helpers:configure-interface",
"adtran-captive-portal-wholesale-helpers:delete-pon-system",
"adtran-captive-portal-wholesale-helpers:deactivate-service",
"adtran-captive-portal-wholesale-helpers:replace-ont",
"adtran-captive-portal-wholesale-helpers:activate-service",
"adtran-captive-portal-wholesale-helpers:add-ont",
"adtran-captive-portal-wholesale-helpers:commission-l2s-device",
"adtran-captive-portal-wholesale-helpers:create-pon-system",
"adtran-captive-portal-wholesale-helpers:delete-dpu-service",
"adtran-captive-portal-wholesale-helpers:create-l2s-device-mgmt-svcs",
"adtran-captive-portal-wholesale-helpers:delete-content-provider",
"adtran-captive-portal-wholesale-helpers:create-dpu-mgmt-svcs-for-l2s",
"adtran-captive-portal-wholesale-helpers:delete-l2s-service",
"adtran-captive-portal-wholesale-helpers:modify-ont",
"adtran-captive-portal-wholesale-helpers:update-pon",
"adtran-captive-portal-wholesale-helpers:update-pon-system",
"adtran-captive-portal-wholesale-helpers:get-pons-of-channel-partition",
"adtran-captive-portal-wholesale-helpers:delete-channel-partition",
"adtran-captive-portal-wholesale-helpers:create-l2s-service",
"adtran-captive-portal-wholesale-helpers:delete-l2s-device-mgmt-svcs",
"adtran-captive-portal-wholesale-helpers:create-dpu-service",
"adtran-captive-portal-wholesale-helpers:create-ses-service",
"adtran-captive-portal-wholesale-helpers:commission-dpu",
"adtran-auth-radius-attributes-mapping:modify-radius-attributes-mapping",
"adtran-cloud-platform-subscriber-accounting:write-config",
"adtran-cloud-platform-subscriber-accounting:read-config",
"adtran-nbi-ipaa-ssh:ipaa-config-ssh",
"adtran-system-config:modify-config",
"adtran-vssm-gx-session:gx-session",
"adtran-cloud-platform-restconf-streams:stream-read",
"adtran-cloud-platform-dhcp-lease:read-dhcp-lease",
"adtran-cloud-platform-device-credentials:modify-adtn-cld-pfrm-dev-crdls",
"adtran-cloud-platform-device-credentials:read-adtn-cld-pfrm-dev-crdls",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-service-profiles",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-content-providers",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-services",
"adtran-trap-forwarder:trap-config-read",
"adtran-trap-forwarder:trap-config-write",
"adtran-device-proxy:device-read",
"adtran-device-proxy:device-write",
"adtran-device-proxy:server-write",
"adtran-device-proxy:device-execute",
"adtran-cloud-platform-device-backup:modify-adtn-cld-pfrm-dev-bkup",
"adtran-cloud-platform-device-backup:read-adtn-cld-pfrm-dev-bkup",
"adtran-ffui-applications:read-apps-info",
"adtran-ffui-applications:write-apps-info",
"adtran-captive-portal-service-transition:read-service-transitions",
"adtran-cloud-platform-enablement-adapter:run-ebmt-adpt-trap-receiver",
"adtran-cloud-platform-dhcp-profiles:modify-dhcp-profile",
"adtran-cloud-platform-dhcp-profiles:read-dhcp-profile",
"adtran-dhcp-ont-activations:read-adtn-dhcp-ont-act",
"adtran-cloud-platform-service-test-y1731:run-test-y1731",
"adtran-cloud-platform-service-test-y1731:run-graph-y1731",
"adtran-cloud-platform-service-test-y1731:read-y1731-tests",
"adtran-cxui-types:read-adtn-cxui-sip-stats",
"adtran-cxui-types:read-adtn-cxui-dev",
"adtran-cxui-types:read-adtn-cxui-vqm",
"adtran-cxui-types:modify-adtn-cxui-dev",
"adtran-cxui-types:read-adtn-cxui-dev-stats",
"adtran-launchpad-login:modify-browser-page",
"adtran-launchpad-login:modify-login-page",
"adtran-cloud-platform-restconf-service:read-permission",
"adtran-cloud-platform-restconf-service:subscribe-notifications",
"adtran-cloud-platform-restconf-service:get-all-device-notifications",
"adtran-cloud-platform-restconf-service:read-schema",
"adtran-cloud-platform-restconf-service:write-config",
"adtran-cloud-platform-restconf-service:delete-config",
"adtran-cloud-platform-restconf-service:get-all-device-sessions",
"adtran-cloud-platform-restconf-service:unsubscribe-notifications",
"adtran-cloud-platform-restconf-service:read-session",
"adtran-cloud-platform-restconf-service:reboot-device",
"adtran-cloud-platform-restconf-service:execute-rpc",
"adtran-cloud-platform-restconf-service:close-session",
"adtran-cloud-platform-restconf-service:read-config",
"adtran-cloud-platform-restconf-service:reestablish-session",
"adtran-cloud-platform-restconf-service:open-session",
"adtran-cloud-platform-dfn-peer-configuration:modify-dfn-pr-configuration",
"adtran-cloud-platform-dfn-peer-configuration:read-dfn-pr-configuration",
"adtran-cloud-platform-uiworkflow-part-numbers:read-uiworkflow-part-number",
"adtran-cloud-platform-uiworkflow-data-centers:read-uiworkflow-data-centers",
"adtran-feature-flags:config-flag",
"adtran-cloud-platform-subscriber-session-status:read-subscriber-session",
"adtran-auth-group:modify-groups",
"adtran-cloud-platform-dfn-configuration:modify-dfn-configuration",
"adtran-cloud-platform-dfn-configuration:read-dfn-configuration",
"adtran-file-transfer:read-adtn-file-xfer-sftp-cfg",
"adtran-file-transfer:modify-adtn-file-xfer-sftp-cfg",
"adtran-cloud-platform-event-enrichment-helper:event-enrichment-helper",
"adtran-cloud-platform-uiworkflow-bundles:read-uiworkflow-bundle-type",
"adtran-cloud-platform-uiworkflow-bundles:read-uiworkflow-bundles",
"adtran-cloud-platform-uiworkflow-bundles:filter-uiworkflow-bundle-resources",
"adtran-cloud-platform-credentials:modify-adtn-cld-pfrm-crdls",
"adtran-cloud-platform-credentials:read-adtn-cld-pfrm-crdls",
"adtran-cloud-platform-deferred-intent-service:execute-intent-operation",
"adtran-vssm-gx-config:read-gx-apn-config",
"adtran-cloud-platform-settings:modify-adtn-cld-pfrm-set",
"adtran-cloud-platform-settings:read-adtn-cld-pfrm-set",
"adtran-cloud-platform-uiworkflow-device-credentials:read-adtn-cld-pfrm-uiw-dev-crdls",
"adtran-cloud-platform-subscriber-session-manager:config-sessions",
"adtran-cloud-platform-subscriber-session-manager:read-subscribers",
"adtran-ffui-workboards:read-workboards",
"adtran-ffui-workboards:modify-workboards",
"adtran-cloud-platform-vssm-gx-statistics:gx-stats-perm",
"adtran-nbi-sysmon:sysmon-config",
"adtran-nbi-sysmon:sysmon-read",
"adtran-nbi-ipaa:ipaa-config",
"adtran-cloud-platform-uiworkflow-profiles:read-profile",
"adtran-cloud-platform-management-domain-coordination:deploy-mgmt-domains",
"adtran-cloud-platform-management-domain-coordination:delete-mgmt-domains",
"adtran-cloud-platform-management-domain-coordination:activate-mgmt-domains",
"adtran-cloud-platform-management-domain-coordination:deactivate-mgmt-domains",
"adtran-cloud-platform-management-domain-coordination:undeploy-mgmt-domains",
"adtran-cloud-platform-management-domain-coordination:config-mgmt-domains",
"adtran-cloud-platform-maintenance-services:read-action-status",
"adtran-cloud-platform-maintenance-services:execute-action",
"adtran-captive-portal-services:deploy-service",
"adtran-captive-portal-services:activate-service",
"adtran-captive-portal-services:find-service",
"adtran-captive-portal-services:delete-service",
"adtran-captive-portal-services:read-service-status",
"adtran-captive-portal-services:undeploy-service",
"adtran-captive-portal-services:read-service",
"adtran-captive-portal-services:configure-service",
"adtran-captive-portal-services:modify-service",
"adtran-captive-portal-services:deactivate-service",
"adtran-cloud-platform-netconf-client-service:write-config",
"adtran-cloud-platform-netconf-client-service:execute-rpc",
"adtran-cloud-platform-netconf-client-service:subscribe-notifications",
"adtran-cloud-platform-netconf-client-service:unsubscribe-notifications",
"adtran-cloud-platform-netconf-client-service:read-session",
"adtran-cloud-platform-netconf-client-service:read-config",
"adtran-cloud-platform-netconf-client-service:delete-config",
"adtran-cloud-platform-netconf-client-service:get-all-device-sessions",
"adtran-cloud-platform-netconf-client-service:open-session",
"adtran-cloud-platform-netconf-client-service:close-session",
"adtran-cloud-platform-netconf-client-service:reboot-device",
"adtran-cloud-platform-netconf-client-service:reestablish-session",
"adtran-cloud-platform-netconf-client-service:read-schema",
"adtran-captive-portal-types:modify-server-credentials",
"adtran-captive-portal-types:activate-service",
"adtran-captive-portal-types:read-user-logs",
"adtran-captive-portal-types:read-activation-logs",
"adtran-captive-portal-types:read-server-credentials",
"adtran-dhcp-leases:read-adtn-dhcp-lease",
"adtran-cloud-platform-diameter-config:diameter-config"
]
},
{
"domains": [],
"name": "topology-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-services",
"adtran-cloud-platform-services:read-service",
"adtran-cloud-platform-uiworkflow-topology:run-uiworkflow-topology",
"adtran-cloud-platform-uiworkflow-topology:read-uiworkflow-topology"
]
},
{
"domains": [],
"name": "user-groups-admin",
"permissions": [
"adtran-auth-group:modify-groups",
"adtran-auth-user:modify-users",
"adtran-auth-permission:all"
]
},
{
"domains": [],
"name": "users-admin",
"permissions": [
"adtran-auth-user:modify-users",
"adtran-auth-permission:all",
"adtran-auth-user:administer-users"
]
},
{
"domains": [],
"name": "view-modify-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-jobs:read-adtn-cld-pfrm-job",
"adtran-captive-portal-content-providers:read-content-provider",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-cloud-platform-bundles:read-adtn-cld-pfrm-bndl",
"adtran-cloud-platform-services:read-service",
"adtran-cloud-platform-profiles:read-profile",
"adtran-cloud-platform-servers:read-adtn-cld-pfrm-srvr",
"adtran-cloud-platform-management-domains:read-adtn-cld-pfrm-md",
"adtran-cloud-platform-data-centers:read-adtn-cld-pfrm-data-ctr",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions"
]
},
{
"domains": [],
"name": "view-read-user",
"permissions": [
"adtran-cloud-platform-search:execute-search"
]
}
]
},
"example": [
{
"domains": [],
"name": "activate-device-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow-devices:read-uiworkflow-devices",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-auth-permission:all",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-cloud-platform-management-domains:read-adtn-cld-pfrm-md",
"adtran-cloud-platform-profiles:read-profile",
"adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interfaces",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domain-types",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domains",
"adtran-cloud-platform-uiworkflow-part-numbers:read-uiworkflow-part-number",
"adtran-cloud-platform-uiworkflow-profiles:read-profile"
]
},
{
"domains": [],
"name": "activate-interface-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interfaces",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-auth-permission:all",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-profiles:read-profile",
"adtran-cloud-platform-uiworkflow-bundles:read-uiworkflow-bundles",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-cloud-platform-uiworkflow-devices:read-uiworkflow-devices",
"adtran-cloud-platform-uiworkflow-interfaces:filter-uiworkflow-interface-resources",
"adtran-cloud-platform-uiworkflow-interfaces:filter-uiworkflow-physical-resources",
"adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interface-type",
"adtran-cloud-platform-uiworkflow-profiles:read-profile"
]
},
{
"domains": [],
"name": "activate-job-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow-jobs:read-job",
"adtran-cloud-platform-jobs:read-adtn-cld-pfrm-job",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-profiles:read-profile",
"adtran-cloud-platform-uiworkflow-devices:read-uiworkflow-devices",
"adtran-cloud-platform-uiworkflow-jobs:get-job-context",
"adtran-cloud-platform-uiworkflow-jobs:read-action",
"adtran-cloud-platform-uiworkflow-jobs:read-trigger",
"adtran-cloud-platform-uiworkflow-profiles:read-profile"
]
},
{
"domains": [],
"name": "activate-management-domain-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domains",
"adtran-cloud-platform-management-domains:read-adtn-cld-pfrm-md",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-auth-permission:all",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domain-types"
]
},
{
"domains": [],
"name": "activate-profile-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-auth-permission:all",
"adtran-cloud-platform-profiles:config-profile",
"adtran-cloud-platform-hardware:read-profile",
"adtran-yang-datastore:read-yang-model",
"adtran-yang-datastore:write-yang-model"
]
},
{
"domains": [],
"name": "activate-profile-vector-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow-profiles:read-profile",
"adtran-cloud-platform-profiles:read-profile",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-labels:read-labels",
"adtran-yang-datastore:read-yang-model",
"adtran-yang-datastore:write-yang-model",
"adtran-cloud-platform-profiles:config-profile",
"adtran-auth-permission:all",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-content-providers",
"adtran-cloud-platform-uiworkflow-bundles:read-uiworkflow-bundles",
"adtran-cloud-platform-servers:read-adtn-cld-pfrm-srvr",
"adtran-cloud-platform-profiles:config-profile"
]
},
{
"domains": [],
"name": "activate-provider-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-content-providers",
"adtran-captive-portal-content-providers:read-content-provider",
"adtran-auth-permission:all"
]
},
{
"domains": [],
"name": "activate-server-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow-servers:read-uiworkflow-servers",
"adtran-cloud-platform-servers:read-adtn-cld-pfrm-srvr",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-auth-permission:all"
]
},
{
"domains": [],
"name": "activate-service-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-captive-portal-services:activate-service",
"adtran-captive-portal-services:deactivate-service",
"adtran-captive-portal-service-transition:read-service-transitions",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-services",
"adtran-cloud-platform-services:read-service",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-catalog",
"adtran-auth-permission:all",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-yang-datastore:read-yang-model",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-content-providers",
"adtran-cloud-platform-labels:read-labels"
]
},
{
"domains": [],
"name": "activate-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow-devices:read-uiworkflow-devices",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interfaces",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-cloud-platform-uiworkflow-jobs:read-job",
"adtran-cloud-platform-jobs:read-adtn-cld-pfrm-job",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domains",
"adtran-cloud-platform-management-domains:read-adtn-cld-pfrm-md",
"adtran-cloud-platform-uiworkflow-servers:read-uiworkflow-servers",
"adtran-cloud-platform-servers:read-adtn-cld-pfrm-srvr",
"adtran-captive-portal-services:activate-service",
"adtran-captive-portal-services:deactivate-service",
"adtran-captive-portal-service-transition:read-service-transitions",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-services",
"adtran-cloud-platform-services:read-service",
"adtran-cloud-platform-uiworkflow-profiles:read-profile",
"adtran-cloud-platform-profiles:read-profile",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-content-providers",
"adtran-captive-portal-content-providers:read-content-provider",
"adtran-cloud-platform-labels:read-labels"
]
},
{
"domains": [],
"name": "audit-log-admin",
"permissions": [
"adtran-auth-accounting:read-accounting-logs"
]
},
{
"domains": [],
"name": "configure-device-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow-devices:read-uiworkflow-devices",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-configure",
"adtran-cloud-platform-uiworkflow-part-numbers:read-uiworkflow-part-number",
"adtran-cloud-platform-uiworkflow-profiles:read-profile",
"adtran-cloud-platform-profiles:read-profile",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domain-types",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domains",
"adtran-cloud-platform-management-domains:read-adtn-cld-pfrm-md",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-auth-permission:all",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interfaces",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete"
]
},
{
"domains": [],
"name": "configure-interface-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interface-type",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-configure",
"adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interfaces",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-cloud-platform-uiworkflow-profiles:read-profile",
"adtran-cloud-platform-profiles:read-profile",
"adtran-auth-permission:all",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-uiworkflow-bundles:read-uiworkflow-bundles",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-cloud-platform-uiworkflow-devices:read-uiworkflow-devices",
"adtran-cloud-platform-uiworkflow-interfaces:filter-uiworkflow-interface-resources",
"adtran-cloud-platform-uiworkflow-interfaces:filter-uiworkflow-physical-resources",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete"
]
},
{
"domains": [],
"name": "configure-job-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-configure",
"adtran-cloud-platform-uiworkflow-jobs:read-job",
"adtran-cloud-platform-jobs:read-adtn-cld-pfrm-job",
"adtran-cloud-platform-uiworkflow-jobs:read-action",
"adtran-cloud-platform-uiworkflow-jobs:read-trigger",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-profiles:read-profile",
"adtran-cloud-platform-uiworkflow-devices:read-uiworkflow-devices",
"adtran-cloud-platform-uiworkflow-jobs:get-job-context",
"adtran-cloud-platform-uiworkflow-profiles:read-profile",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete"
]
},
{
"domains": [],
"name": "configure-management-domain-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-configure",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domain-types",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domains",
"adtran-cloud-platform-management-domains:read-adtn-cld-pfrm-md",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-auth-permission:all",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete"
]
},
{
"domains": [],
"name": "configure-profile-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-configure",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-auth-permission:all",
"adtran-cloud-platform-profiles:config-profile",
"adtran-cloud-platform-hardware:read-profile",
"adtran-yang-datastore:read-yang-model",
"adtran-yang-datastore:write-yang-model"
]
},
{
"domains": [],
"name": "configure-profile-vector-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-configure",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-content-providers",
"adtran-captive-portal-content-providers:read-content-provider",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-auth-permission:all",
"adtran-cloud-platform-profiles:config-profile",
"adtran-cloud-platform-hardware:read-profile",
"adtran-yang-datastore:read-yang-model",
"adtran-yang-datastore:write-yang-model"
]
},
{
"domains": [],
"name": "configure-provider-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-configure",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-content-providers",
"adtran-captive-portal-content-providers:read-content-provider",
"adtran-auth-permission:all",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions"
]
},
{
"domains": [],
"name": "configure-server-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-configure",
"adtran-cloud-platform-uiworkflow-servers:read-uiworkflow-servers",
"adtran-cloud-platform-servers:read-adtn-cld-pfrm-srvr",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-auth-permission:all"
]
},
{
"domains": [],
"name": "configure-service-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-service-profiles",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-services",
"adtran-cloud-platform-services:modify-service",
"adtran-cloud-platform-services:read-service",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-catalog",
"adtran-auth-permission:all",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-configure",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-yang-datastore:read-yang-model",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-content-providers",
"adtran-cloud-platform-labels:read-labels"
]
},
{
"domains": [],
"name": "deploy-device-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow-devices:read-uiworkflow-devices",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-undeploy",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interfaces",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-auth-permission:all",
"adtran-cloud-platform-profiles:read-profile",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-management-domains:read-adtn-cld-pfrm-md",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domain-types",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domains",
"adtran-cloud-platform-uiworkflow-part-numbers:read-uiworkflow-part-number",
"adtran-cloud-platform-uiworkflow-profiles:read-profile"
]
},
{
"domains": [],
"name": "deploy-interface-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interfaces",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-cloud-platform-uiworkflow-devices:read-uiworkflow-devices",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-uiworkflow-interfaces:filter-uiworkflow-interface-resources",
"adtran-cloud-platform-uiworkflow-interfaces:filter-uiworkflow-physical-resources",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-undeploy",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow-bundles:read-uiworkflow-bundles",
"adtran-auth-permission:all",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-profiles:read-profile",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interface-type",
"adtran-cloud-platform-uiworkflow-profiles:read-profile"
]
},
{
"domains": [],
"name": "deploy-job-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow-jobs:read-job",
"adtran-cloud-platform-jobs:read-adtn-cld-pfrm-job",
"adtran-cloud-platform-uiworkflow-devices:read-uiworkflow-devices",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-uiworkflow-profiles:read-profile",
"adtran-cloud-platform-profiles:read-profile",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-undeploy",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow-jobs:get-job-context",
"adtran-cloud-platform-uiworkflow-jobs:read-action",
"adtran-cloud-platform-uiworkflow-jobs:read-trigger"
]
},
{
"domains": [],
"name": "deploy-management-domain-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domains",
"adtran-cloud-platform-management-domains:read-adtn-cld-pfrm-md",
"adtran-cloud-platform-uiworkflow-servers:read-uiworkflow-servers",
"adtran-cloud-platform-servers:read-adtn-cld-pfrm-srvr",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-undeploy",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-auth-permission:all",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domain-types"
]
},
{
"domains": [],
"name": "deploy-profile-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-undeploy",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-auth-permission:all",
"adtran-cloud-platform-profiles:config-profile",
"adtran-cloud-platform-hardware:read-profile",
"adtran-yang-datastore:read-yang-model",
"adtran-yang-datastore:write-yang-model"
]
},
{
"domains": [],
"name": "deploy-profile-vector-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow-profiles:read-profile",
"adtran-cloud-platform-profiles:read-profile",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-undeploy",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-auth-permission:all",
"adtran-yang-datastore:read-yang-model",
"adtran-yang-datastore:write-yang-model"
]
},
{
"domains": [],
"name": "deploy-provider-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-content-providers",
"adtran-captive-portal-content-providers:read-content-provider",
"adtran-cloud-platform-uiworkflow-devices:read-uiworkflow-devices",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-undeploy",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-auth-permission:all"
]
},
{
"domains": [],
"name": "deploy-server-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow-servers:read-uiworkflow-servers",
"adtran-cloud-platform-servers:read-adtn-cld-pfrm-srvr",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-undeploy",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-auth-permission:all"
]
},
{
"domains": [],
"name": "deploy-service-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-services",
"adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interfaces",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-content-providers",
"adtran-captive-portal-content-providers:read-content-provider",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-undeploy",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-services:read-service",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-catalog",
"adtran-auth-permission:all",
"adtran-yang-datastore:read-yang-model",
"adtran-cloud-platform-labels:read-labels"
]
},
{
"domains": [],
"name": "edit-device-user",
"permissions": [
"adtran-auth-permission:all",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-management-domains:read-adtn-cld-pfrm-md",
"adtran-cloud-platform-profiles:read-profile",
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-cloud-platform-uiworkflow-devices:read-uiworkflow-devices",
"adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interfaces",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domain-types",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domains",
"adtran-cloud-platform-uiworkflow-part-numbers:read-uiworkflow-part-number",
"adtran-cloud-platform-uiworkflow-profiles:read-profile",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-configure",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-undeploy"
]
},
{
"domains": [],
"name": "edit-interface-user",
"permissions": [
"adtran-auth-permission:all",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-profiles:read-profile",
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow-bundles:read-uiworkflow-bundles",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-cloud-platform-uiworkflow-devices:read-uiworkflow-devices",
"adtran-cloud-platform-uiworkflow-interfaces:filter-uiworkflow-interface-resources",
"adtran-cloud-platform-uiworkflow-interfaces:filter-uiworkflow-physical-resources",
"adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interface-type",
"adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interfaces",
"adtran-cloud-platform-uiworkflow-profiles:read-profile",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-configure",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-undeploy"
]
},
{
"domains": [],
"name": "edit-job-user",
"permissions": [
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-jobs:read-adtn-cld-pfrm-job",
"adtran-cloud-platform-jobs:modify-adtn-cld-pfrm-job",
"adtran-cloud-platform-profiles:read-profile",
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow-devices:read-uiworkflow-devices",
"adtran-cloud-platform-uiworkflow-jobs:get-job-context",
"adtran-cloud-platform-uiworkflow-jobs:read-action",
"adtran-cloud-platform-uiworkflow-jobs:read-job",
"adtran-cloud-platform-uiworkflow-jobs:read-trigger",
"adtran-cloud-platform-uiworkflow-profiles:read-profile",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-configure",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-undeploy"
]
},
{
"domains": [],
"name": "edit-management-domain-user",
"permissions": [
"adtran-auth-permission:all",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-management-domains:read-adtn-cld-pfrm-md",
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-servers:read-adtn-cld-pfrm-srvr",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domain-types",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domains",
"adtran-cloud-platform-uiworkflow-servers:read-uiworkflow-servers",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-configure",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-undeploy"
]
},
{
"domains": [],
"name": "edit-profile-user",
"permissions": [
"adtran-auth-permission:all",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-management-domains:read-adtn-cld-pfrm-md",
"adtran-cloud-platform-profiles:read-profile",
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-cloud-platform-uiworkflow-profiles:read-profile",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-configure",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-undeploy",
"adtran-cloud-platform-profiles:config-profile",
"adtran-yang-datastore:read-yang-model",
"adtran-yang-datastore:write-yang-model"
]
},
{
"domains": [],
"name": "edit-profile-vector-user",
"permissions": [
"adtran-auth-permission:all",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-management-domains:read-adtn-cld-pfrm-md",
"adtran-cloud-platform-profiles:read-profile",
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-cloud-platform-uiworkflow-profiles:read-profile",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-configure",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-undeploy",
"adtran-cloud-platform-servers:read-adtn-cld-pfrm-srvr",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-content-providers",
"adtran-cloud-platform-uiworkflow-bundles:read-uiworkflow-bundles",
"adtran-cloud-platform-profiles:config-profile",
"adtran-yang-datastore:read-yang-model",
"adtran-yang-datastore:write-yang-model"
]
},
{
"domains": [],
"name": "edit-provider-user",
"permissions": [
"adtran-auth-permission:all",
"adtran-captive-portal-content-providers:read-content-provider",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow-devices:read-uiworkflow-devices",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-content-providers",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-configure",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-undeploy"
]
},
{
"domains": [],
"name": "edit-server-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-configure",
"adtran-cloud-platform-uiworkflow-servers:read-uiworkflow-servers",
"adtran-cloud-platform-servers:read-adtn-cld-pfrm-srvr",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-auth-permission:all",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-undeploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate"
]
},
{
"domains": [],
"name": "edit-service-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-captive-portal-services:activate-service",
"adtran-captive-portal-services:deactivate-service",
"adtran-captive-portal-service-transition:read-service-transitions",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-services",
"adtran-cloud-platform-services:read-service",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-catalog",
"adtran-auth-permission:all",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-yang-datastore:read-yang-model",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-service-profiles",
"adtran-cloud-platform-services:modify-service",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-configure",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete",
"adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interfaces",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-content-providers",
"adtran-captive-portal-content-providers:read-content-provider",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-undeploy",
"adtran-cloud-platform-labels:read-labels"
]
},
{
"domains": [],
"name": "edit-ui-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-configure",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-content-providers",
"adtran-captive-portal-content-providers:read-content-provider",
"adtran-cloud-platform-uiworkflow-devices:read-uiworkflow-devices",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-uiworkflow-servers:read-uiworkflow-servers",
"adtran-cloud-platform-servers:read-adtn-cld-pfrm-srvr",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-undeploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-service-profiles",
"adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interfaces",
"adtran-cloud-platform-uiworkflow-interfaces:filter-uiworkflow-physical-resources",
"adtran-cloud-platform-uiworkflow-bundles:read-uiworkflow-bundles",
"adtran-auth-permission:all",
"adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interface-type",
"adtran-cloud-platform-uiworkflow-profiles:read-profile",
"adtran-cloud-platform-profiles:read-profile",
"adtran-cloud-platform-bundles:read-adtn-cld-pfrm-bndl",
"adtran-cloud-platform-data-centers:read-adtn-cld-pfrm-data-ctr",
"adtran-captive-portal-service-transition:read-service-transitions",
"adtran-captive-portal-services:activate-service",
"adtran-captive-portal-services:deactivate-service",
"adtran-cloud-platform-hardware:read-profile",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-labels:modify-labels",
"adtran-cloud-platform-management-domains:read-adtn-cld-pfrm-md",
"adtran-cloud-platform-profiles:config-profile",
"adtran-cloud-platform-services:modify-service",
"adtran-cloud-platform-services:read-service",
"adtran-cloud-platform-uiworkflow-bundles:read-uiworkflow-bundle-type",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-cloud-platform-uiworkflow-interfaces:filter-uiworkflow-interface-resources",
"adtran-cloud-platform-uiworkflow-jobs:get-job-context",
"adtran-cloud-platform-uiworkflow-jobs:read-action",
"adtran-cloud-platform-uiworkflow-jobs:read-job",
"adtran-cloud-platform-uiworkflow-jobs:read-trigger",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domain-types",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domains",
"adtran-cloud-platform-uiworkflow-part-numbers:read-uiworkflow-part-number",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-services",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-catalog",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete",
"adtran-yang-datastore:read-yang-model",
"adtran-yang-datastore:write-yang-model",
"adtran-cloud-platform-ui-inspect:run-request",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev-inspect",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int-inspect",
"adtran-cloud-platform-jobs:read-adtn-cld-pfrm-job"
]
},
{
"domains": [],
"name": "events-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-event-workflow:event-read"
]
},
{
"domains": [],
"name": "group-permissions-admin",
"permissions": [
"adtran-auth-group:modify-groups",
"adtran-auth-permission:all"
]
},
{
"domains": [],
"name": "groups-admin",
"permissions": [
"adtran-auth-group:modify-groups",
"adtran-auth-permission:all"
]
},
{
"domains": [],
"name": "inspect-ui-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-ui-inspect:run-request",
"adtran-cloud-platform-uiworkflow-devices:read-uiworkflow-devices",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev-inspect",
"adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interfaces",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int-inspect",
"adtran-cloud-platform-uiworkflow-servers:read-uiworkflow-servers",
"adtran-cloud-platform-servers:read-adtn-cld-pfrm-srvr",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-services",
"adtran-cloud-platform-services:read-service",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-content-providers",
"adtran-captive-portal-content-providers:read-content-provider",
"adtran-cloud-platform-uiworkflow-jobs:read-job",
"adtran-cloud-platform-jobs:read-adtn-cld-pfrm-job",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domains",
"adtran-cloud-platform-management-domains:read-adtn-cld-pfrm-md",
"adtran-cloud-platform-uiworkflow-profiles:read-profile",
"adtran-cloud-platform-profiles:read-profile",
"adtran-cloud-platform-labels:read-labels"
]
},
{
"domains": [],
"name": "login-banner-admin",
"permissions": [
"adtran-launchpad-login:modify-login-page",
"adtran-launchpad-login:modify-browser-page",
"adtran-cloud-platform-settings:read-adtn-cld-pfrm-set",
"adtran-cloud-platform-settings:modify-adtn-cld-pfrm-set",
"adtran-auth-permission:anonymous"
]
},
{
"domains": [],
"name": "mosaic-user",
"permissions": [
"adtran-auth-permission:all",
"adtran-ffui-workboards:modify-workboards",
"adtran-ffui-workboards:read-workboards",
"adtran-ffui-applications:read-apps-info",
"adtran-ffui-applications:write-apps-info",
"adtran-cloud-platform-information:read-information",
"adtran-cloud-platform-plugin:get-plugins"
]
},
{
"domains": [],
"name": "super-user",
"permissions": [
"adtran-cloud-platform-uiworkflow:run-uiworkflow-configure",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-suspend-resume",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-undeploy",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-catalog",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-onboard-device",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:force-delete",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-notify",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deploy",
"adtran-auth-permission:all",
"adtran-auth-permission:anonymous",
"adtran-export-data-service:export-data-service",
"adtran-cloud-platform-topics:configure-topics",
"adtran-cloud-platform-topics:read-topics",
"adtran-cloud-platform-jobs:read-adtn-cld-pfrm-job",
"adtran-cloud-platform-jobs:modify-adtn-cld-pfrm-job",
"adtran-cloud-platform-software-upgrade-service:download-software",
"adtran-cloud-platform-software-upgrade-service:commit-software",
"adtran-cloud-platform-software-upgrade-service:reboot-device",
"adtran-cloud-platform-software-upgrade-service:commit-and-activate-software",
"adtran-cloud-platform-software-upgrade-service:activate-software",
"adtran-ffui-settings:modify-settings",
"adtran-ffui-settings:read-settings",
"adtran-cloud-platform-server-coordination:communicate-servers",
"adtran-cloud-platform-server-coordination:activate-servers",
"adtran-cloud-platform-server-coordination:delete-servers",
"adtran-cloud-platform-server-coordination:config-servers",
"adtran-cloud-platform-server-coordination:undeploy-servers",
"adtran-cloud-platform-server-coordination:deploy-servers",
"adtran-cloud-platform-server-coordination:deactivate-servers",
"adtran-auth-tech-support:generate-tech-support-challenges",
"adtran-auth-domain:modify-domains",
"adtran-cloud-platform-uiworkflow-topology:run-uiworkflow-topology",
"adtran-cloud-platform-uiworkflow-topology:read-uiworkflow-topology",
"adtran-cloud-platform-management-domains:modify-adtn-cld-pfrm-md",
"adtran-cloud-platform-management-domains:read-adtn-cld-pfrm-md",
"adtran-cloud-platform-elasticsearch-rollover-indices:rollover-cron-update",
"adtran-cloud-platform-elasticsearch-rollover-indices:read-adtn-cld-pfrm-es-rlvr-indcs",
"adtran-cloud-platform-elasticsearch-rollover-indices:modify-adtn-cld-pfrm-es-rlvr-indcs",
"adtran-nms-inventory:read-inventory",
"adtran-captive-portal-policers:modify-policer",
"adtran-captive-portal-policers:read-policer",
"adtran-ffui-workboards-yds:modify-workboards",
"adtran-ffui-workboards-yds:read-workboards",
"adtran-cloud-platform-event-workflow:event-clear",
"adtran-cloud-platform-event-workflow:event-read",
"adtran-cloud-platform-event-workflow:event-write",
"adtran-cloud-platform-event-workflow:read-event-workflow-transitions",
"adtran-cloud-platform-hardware:read-profile",
"adtran-yang-datastore:write-yang-model",
"adtran-yang-datastore:read-yang-model",
"adtran-vssm-gx-subscriber-data:read-subscriber-data",
"adtran-cloud-platform-dhcp-config:dhcp-config",
"adtran-cloud-platform-uiworkflow-jobs:read-action",
"adtran-cloud-platform-uiworkflow-jobs:read-run-job-transitions",
"adtran-cloud-platform-uiworkflow-jobs:run-job-with-parameters",
"adtran-cloud-platform-uiworkflow-jobs:get-job-context",
"adtran-cloud-platform-uiworkflow-jobs:run-job",
"adtran-cloud-platform-uiworkflow-jobs:read-job",
"adtran-cloud-platform-uiworkflow-jobs:read-trigger",
"adtran-cloud-platform-services:read-service",
"adtran-cloud-platform-services:modify-service",
"adtran-cloud-platform-software-upgrade-maintenance-service:get-upgrade-summary-status",
"adtran-cloud-platform-software-upgrade-maintenance-service:initiate-upgrade",
"adtran-cloud-platform-software-upgrade-maintenance-service:get-upgrade-status",
"adtran-cloud-platform-dhcp-subscriber-profile-mapping:modify-subscriber-profile-mapping",
"adtran-cloud-platform-dhcp-subscriber-profile-mapping:read-subscriber-profile-mapping",
"adtran-cloud-platform-profiles-pools:read-profile-pool",
"adtran-cloud-platform-profiles-pools:modify-profile-pools",
"adtran-cloud-platform-y1731-session-measurement-report:read-report",
"adtran-auth-user:modify-users",
"adtran-auth-user:administer-users",
"adtran-cloud-platform-bundles:read-adtn-cld-pfrm-bndl",
"adtran-cloud-platform-bundles:modify-adtn-cld-pfrm-bndl",
"adtran-cloud-platform-service-test-rfc2544:run-test-rfc2544",
"adtran-cloud-platform-service-test-rfc2544:read-rfc2544-tests",
"adtran-vssm-gx-handler:gx-handler",
"adtran-cloud-platform-deferred-intents:read-deferred-intents",
"adtran-cloud-platform-servers:modify-adtn-cld-pfrm-srvr",
"adtran-cloud-platform-servers:read-adtn-cld-pfrm-srvr",
"adtran-cloud-platform-data-centers:modify-adtn-cld-pfrm-data-ctr",
"adtran-cloud-platform-data-centers:read-adtn-cld-pfrm-data-ctr",
"adtran-dhcp-autoprov-info:read-adtn-dhcp-ap-info",
"adtran-cloud-platform-business-service-management:service-write",
"adtran-cloud-platform-business-service-management:service-read",
"adtran-cloud-platform-orchestration:read-orchestration-transitions",
"adtran-cloud-platform-orchestration:run-orchestration-create",
"adtran-cloud-platform-orchestration:run-orchestration-modify",
"adtran-cloud-platform-orchestration:run-orchestration-delete",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-auth-config:modify-config",
"adtran-cloud-platform-uiworkflow-servers:read-uiworkflow-servers",
"adtran-cloud-platform-search:administer-search",
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-job-manager:modify-adtn-cld-pfrm-job-mngr",
"adtran-cloud-platform-job-manager:read-adtn-cld-pfrm-job-mngr",
"adtran-manifests:read-adtn-manif",
"adtran-cloud-platform-vssm-diameter-statistics:diameter-stats-perm",
"adtran-captive-portal-sla-profiles:modify-sla-profile",
"adtran-captive-portal-sla-profiles:read-sla-profile",
"adtran-cloud-platform-uiworkflow-data-center-types:read-uiworkflow-data-center-type",
"adtran-cloud-platform-diagnostic-data-maintenance-service:get-diagnostic-job-info",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domain-types",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domains",
"adtran-auth-config-external:modify-config-ext",
"adtran-cloud-platform-uiworkflow-subscribers:read-uiworkflow-subscribers",
"adtran-cloud-platform-uiworkflow-subscribers:filter-uiworkflow-subscriber-resources",
"adtran-auth-accounting:read-accounting-logs",
"adtran-cloud-platform-subscriber-policy:read-subs-policy",
"adtran-cloud-platform-subscriber-policy:modify-subs-policy",
"adtran-captive-portal-content-providers:read-content-provider",
"adtran-captive-portal-content-providers:modify-content-provider",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-devices:modify-adtn-cld-pfrm-dev",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev-inspect",
"adtran-nbi-pm:pm-config",
"adtran-nbi-pm:pm-read",
"adtran-cloud-platform-subscribers:read-adtn-cld-pfrm-subs",
"adtran-cloud-platform-subscribers:modify-adtn-cld-pfrm-subs",
"adtran-cloud-platform-profiles:config-profile",
"adtran-cloud-platform-profiles:read-profile",
"adtran-cloud-platform-ui-inspect:run-request",
"adtran-cloud-platform-ui-inspect:run-action",
"adtran-cloud-platform-alarm-logger:read-alarm-logs",
"adtran-server-proxy-by-name:server-read",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-labels:modify-labels",
"adtran-cloud-platform-event-description:configure-event-description",
"adtran-cloud-platform-event-description:read-event-description",
"adtran-cloud-platform-proxy-service:server-read",
"adtran-cloud-platform-proxy-service:server-write",
"adtran-cloud-platform-proxy-service:mount-point-read",
"adtran-cloud-platform-proxy-service:device-read",
"adtran-cloud-platform-proxy-service:device-write",
"adtran-cloud-platform-plugin:get-plugins",
"adtran-cloud-platform-plugin:reload-plugins",
"adtran-cloud-platform-information:read-information",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int-inspect",
"adtran-cloud-platform-interfaces:modify-adtn-cld-pfrm-int",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interface-type",
"adtran-cloud-platform-uiworkflow-interfaces:filter-uiworkflow-interface-resources",
"adtran-cloud-platform-uiworkflow-interfaces:filter-uiworkflow-physical-resources",
"adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interfaces",
"adtran-cloud-platform-connection-monitor:aggregate-sessions-count",
"adtran-cloud-platform-system-monitor:read-system-monitor-node-status",
"adtran-cloud-platform-dfn-route-configuration:read-dfn-rt-configuration",
"adtran-cloud-platform-dfn-route-configuration:modify-dfn-rt-configuration",
"adtran-cloud-platform-uiworkflow-inspect:inspect-uiworkflow-profiles",
"adtran-cloud-platform-uiworkflow-inspect:inspect-uiworkflow-server",
"adtran-cloud-platform-uiworkflow-inspect:manage-uiworkflow-dpu",
"adtran-cloud-platform-uiworkflow-inspect:inspect-uiworkflow-devices",
"adtran-cloud-platform-uiworkflow-inspect:inspect-uiworkflow-interfaces",
"adtran-cloud-platform-uiworkflow-devices:read-uiworkflow-devices",
"adtran-cloud-platform-uiworkflow-behaviors:read-uiworkflow-behavior",
"adtran-cloud-platform-uiworkflow-behaviors:run-uiworkflow-behavior",
"adtran-cloud-platform-base-configurations:modify-adtn-cld-pfrm-bc",
"adtran-cloud-platform-base-configurations:read-adtn-cld-pfrm-bc",
"adtran-captive-portal-wholesale-helpers:remove-ont",
"adtran-captive-portal-wholesale-helpers:delete-ses-service",
"adtran-captive-portal-wholesale-helpers:decommission-l2s-device",
"adtran-captive-portal-wholesale-helpers:delete-dpu-mgmt-svcs-for-l2s",
"adtran-captive-portal-wholesale-helpers:decommission-dpu",
"adtran-captive-portal-wholesale-helpers:create-content-provider",
"adtran-captive-portal-wholesale-helpers:configure-interface",
"adtran-captive-portal-wholesale-helpers:delete-pon-system",
"adtran-captive-portal-wholesale-helpers:deactivate-service",
"adtran-captive-portal-wholesale-helpers:replace-ont",
"adtran-captive-portal-wholesale-helpers:activate-service",
"adtran-captive-portal-wholesale-helpers:add-ont",
"adtran-captive-portal-wholesale-helpers:commission-l2s-device",
"adtran-captive-portal-wholesale-helpers:create-pon-system",
"adtran-captive-portal-wholesale-helpers:delete-dpu-service",
"adtran-captive-portal-wholesale-helpers:create-l2s-device-mgmt-svcs",
"adtran-captive-portal-wholesale-helpers:delete-content-provider",
"adtran-captive-portal-wholesale-helpers:create-dpu-mgmt-svcs-for-l2s",
"adtran-captive-portal-wholesale-helpers:delete-l2s-service",
"adtran-captive-portal-wholesale-helpers:modify-ont",
"adtran-captive-portal-wholesale-helpers:update-pon",
"adtran-captive-portal-wholesale-helpers:update-pon-system",
"adtran-captive-portal-wholesale-helpers:get-pons-of-channel-partition",
"adtran-captive-portal-wholesale-helpers:delete-channel-partition",
"adtran-captive-portal-wholesale-helpers:create-l2s-service",
"adtran-captive-portal-wholesale-helpers:delete-l2s-device-mgmt-svcs",
"adtran-captive-portal-wholesale-helpers:create-dpu-service",
"adtran-captive-portal-wholesale-helpers:create-ses-service",
"adtran-captive-portal-wholesale-helpers:commission-dpu",
"adtran-auth-radius-attributes-mapping:modify-radius-attributes-mapping",
"adtran-cloud-platform-subscriber-accounting:write-config",
"adtran-cloud-platform-subscriber-accounting:read-config",
"adtran-nbi-ipaa-ssh:ipaa-config-ssh",
"adtran-system-config:modify-config",
"adtran-vssm-gx-session:gx-session",
"adtran-cloud-platform-restconf-streams:stream-read",
"adtran-cloud-platform-dhcp-lease:read-dhcp-lease",
"adtran-cloud-platform-device-credentials:modify-adtn-cld-pfrm-dev-crdls",
"adtran-cloud-platform-device-credentials:read-adtn-cld-pfrm-dev-crdls",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-service-profiles",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-content-providers",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-services",
"adtran-trap-forwarder:trap-config-read",
"adtran-trap-forwarder:trap-config-write",
"adtran-device-proxy:device-read",
"adtran-device-proxy:device-write",
"adtran-device-proxy:server-write",
"adtran-device-proxy:device-execute",
"adtran-cloud-platform-device-backup:modify-adtn-cld-pfrm-dev-bkup",
"adtran-cloud-platform-device-backup:read-adtn-cld-pfrm-dev-bkup",
"adtran-ffui-applications:read-apps-info",
"adtran-ffui-applications:write-apps-info",
"adtran-captive-portal-service-transition:read-service-transitions",
"adtran-cloud-platform-enablement-adapter:run-ebmt-adpt-trap-receiver",
"adtran-cloud-platform-dhcp-profiles:modify-dhcp-profile",
"adtran-cloud-platform-dhcp-profiles:read-dhcp-profile",
"adtran-dhcp-ont-activations:read-adtn-dhcp-ont-act",
"adtran-cloud-platform-service-test-y1731:run-test-y1731",
"adtran-cloud-platform-service-test-y1731:run-graph-y1731",
"adtran-cloud-platform-service-test-y1731:read-y1731-tests",
"adtran-cxui-types:read-adtn-cxui-sip-stats",
"adtran-cxui-types:read-adtn-cxui-dev",
"adtran-cxui-types:read-adtn-cxui-vqm",
"adtran-cxui-types:modify-adtn-cxui-dev",
"adtran-cxui-types:read-adtn-cxui-dev-stats",
"adtran-launchpad-login:modify-browser-page",
"adtran-launchpad-login:modify-login-page",
"adtran-cloud-platform-restconf-service:read-permission",
"adtran-cloud-platform-restconf-service:subscribe-notifications",
"adtran-cloud-platform-restconf-service:get-all-device-notifications",
"adtran-cloud-platform-restconf-service:read-schema",
"adtran-cloud-platform-restconf-service:write-config",
"adtran-cloud-platform-restconf-service:delete-config",
"adtran-cloud-platform-restconf-service:get-all-device-sessions",
"adtran-cloud-platform-restconf-service:unsubscribe-notifications",
"adtran-cloud-platform-restconf-service:read-session",
"adtran-cloud-platform-restconf-service:reboot-device",
"adtran-cloud-platform-restconf-service:execute-rpc",
"adtran-cloud-platform-restconf-service:close-session",
"adtran-cloud-platform-restconf-service:read-config",
"adtran-cloud-platform-restconf-service:reestablish-session",
"adtran-cloud-platform-restconf-service:open-session",
"adtran-cloud-platform-dfn-peer-configuration:modify-dfn-pr-configuration",
"adtran-cloud-platform-dfn-peer-configuration:read-dfn-pr-configuration",
"adtran-cloud-platform-uiworkflow-part-numbers:read-uiworkflow-part-number",
"adtran-cloud-platform-uiworkflow-data-centers:read-uiworkflow-data-centers",
"adtran-feature-flags:config-flag",
"adtran-cloud-platform-subscriber-session-status:read-subscriber-session",
"adtran-auth-group:modify-groups",
"adtran-cloud-platform-dfn-configuration:modify-dfn-configuration",
"adtran-cloud-platform-dfn-configuration:read-dfn-configuration",
"adtran-file-transfer:read-adtn-file-xfer-sftp-cfg",
"adtran-file-transfer:modify-adtn-file-xfer-sftp-cfg",
"adtran-cloud-platform-event-enrichment-helper:event-enrichment-helper",
"adtran-cloud-platform-uiworkflow-bundles:read-uiworkflow-bundle-type",
"adtran-cloud-platform-uiworkflow-bundles:read-uiworkflow-bundles",
"adtran-cloud-platform-uiworkflow-bundles:filter-uiworkflow-bundle-resources",
"adtran-cloud-platform-credentials:modify-adtn-cld-pfrm-crdls",
"adtran-cloud-platform-credentials:read-adtn-cld-pfrm-crdls",
"adtran-cloud-platform-deferred-intent-service:execute-intent-operation",
"adtran-vssm-gx-config:read-gx-apn-config",
"adtran-cloud-platform-settings:modify-adtn-cld-pfrm-set",
"adtran-cloud-platform-settings:read-adtn-cld-pfrm-set",
"adtran-cloud-platform-uiworkflow-device-credentials:read-adtn-cld-pfrm-uiw-dev-crdls",
"adtran-cloud-platform-subscriber-session-manager:config-sessions",
"adtran-cloud-platform-subscriber-session-manager:read-subscribers",
"adtran-ffui-workboards:read-workboards",
"adtran-ffui-workboards:modify-workboards",
"adtran-cloud-platform-vssm-gx-statistics:gx-stats-perm",
"adtran-nbi-sysmon:sysmon-config",
"adtran-nbi-sysmon:sysmon-read",
"adtran-nbi-ipaa:ipaa-config",
"adtran-cloud-platform-uiworkflow-profiles:read-profile",
"adtran-cloud-platform-management-domain-coordination:deploy-mgmt-domains",
"adtran-cloud-platform-management-domain-coordination:delete-mgmt-domains",
"adtran-cloud-platform-management-domain-coordination:activate-mgmt-domains",
"adtran-cloud-platform-management-domain-coordination:deactivate-mgmt-domains",
"adtran-cloud-platform-management-domain-coordination:undeploy-mgmt-domains",
"adtran-cloud-platform-management-domain-coordination:config-mgmt-domains",
"adtran-cloud-platform-maintenance-services:read-action-status",
"adtran-cloud-platform-maintenance-services:execute-action",
"adtran-captive-portal-services:deploy-service",
"adtran-captive-portal-services:activate-service",
"adtran-captive-portal-services:find-service",
"adtran-captive-portal-services:delete-service",
"adtran-captive-portal-services:read-service-status",
"adtran-captive-portal-services:undeploy-service",
"adtran-captive-portal-services:read-service",
"adtran-captive-portal-services:configure-service",
"adtran-captive-portal-services:modify-service",
"adtran-captive-portal-services:deactivate-service",
"adtran-cloud-platform-netconf-client-service:write-config",
"adtran-cloud-platform-netconf-client-service:execute-rpc",
"adtran-cloud-platform-netconf-client-service:subscribe-notifications",
"adtran-cloud-platform-netconf-client-service:unsubscribe-notifications",
"adtran-cloud-platform-netconf-client-service:read-session",
"adtran-cloud-platform-netconf-client-service:read-config",
"adtran-cloud-platform-netconf-client-service:delete-config",
"adtran-cloud-platform-netconf-client-service:get-all-device-sessions",
"adtran-cloud-platform-netconf-client-service:open-session",
"adtran-cloud-platform-netconf-client-service:close-session",
"adtran-cloud-platform-netconf-client-service:reboot-device",
"adtran-cloud-platform-netconf-client-service:reestablish-session",
"adtran-cloud-platform-netconf-client-service:read-schema",
"adtran-captive-portal-types:modify-server-credentials",
"adtran-captive-portal-types:activate-service",
"adtran-captive-portal-types:read-user-logs",
"adtran-captive-portal-types:read-activation-logs",
"adtran-captive-portal-types:read-server-credentials",
"adtran-dhcp-leases:read-adtn-dhcp-lease",
"adtran-cloud-platform-diameter-config:diameter-config"
]
},
{
"domains": [],
"name": "topology-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-services",
"adtran-cloud-platform-services:read-service",
"adtran-cloud-platform-uiworkflow-topology:run-uiworkflow-topology",
"adtran-cloud-platform-uiworkflow-topology:read-uiworkflow-topology"
]
},
{
"domains": [],
"name": "user-groups-admin",
"permissions": [
"adtran-auth-group:modify-groups",
"adtran-auth-user:modify-users",
"adtran-auth-permission:all"
]
},
{
"domains": [],
"name": "users-admin",
"permissions": [
"adtran-auth-user:modify-users",
"adtran-auth-permission:all",
"adtran-auth-user:administer-users"
]
},
{
"domains": [],
"name": "view-modify-user",
"permissions": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete",
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls",
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-jobs:read-adtn-cld-pfrm-job",
"adtran-captive-portal-content-providers:read-content-provider",
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-cloud-platform-bundles:read-adtn-cld-pfrm-bndl",
"adtran-cloud-platform-services:read-service",
"adtran-cloud-platform-profiles:read-profile",
"adtran-cloud-platform-servers:read-adtn-cld-pfrm-srvr",
"adtran-cloud-platform-management-domains:read-adtn-cld-pfrm-md",
"adtran-cloud-platform-data-centers:read-adtn-cld-pfrm-data-ctr",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions"
]
},
{
"domains": [],
"name": "view-read-user",
"permissions": [
"adtran-cloud-platform-search:execute-search"
]
}
]
}
}
}
},
"deprecated": false
}
},
"/data/adtran-auth-permission:permissions": {
"get": {
"tags": [
"AAA Permission Groups"
],
"summary": "Retrieve Module Permissions",
"description": "This API is used to retrieve all permissions defined by various modules.\n\n| Attribute | Description |\n| --- | --- |\n| name | Name of the module. |\n| permissions | List of all APIs associated with the module. |",
"operationId": "RetrieveModulePermissions",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"enum": [
"application/json"
],
"type": "string",
"example": "application/json"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"access-control-allow-origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"content-encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "gzip"
},
"example": "gzip"
}
}
},
"content-type": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "application/json; charset=UTF-8"
},
"example": "application/json; charset=UTF-8"
}
}
},
"date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 05 May 2020 09:54:08 GMT"
},
"example": "Tue, 05 May 2020 09:54:08 GMT"
}
}
},
"transfer-encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"vary": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
},
"example": "Accept-Encoding"
}
}
},
"x-frame-options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RetrieveModulePermissions-Success"
},
"example": {
"module": [
{
"name": "adtran-cloud-platform-uiworkflow",
"permission": [
"adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-configure",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-undeploy",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-delete",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-activate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-notify",
"adtran-cloud-platform-uiworkflow:read-uiworkflow-catalog",
"adtran-cloud-platform-uiworkflow:run-uiworkflow-onboard-device",
"adtran-cloud-platform-uiworkflow:force-delete"
]
},
{
"name": "adtran-auth-permission",
"permission": [
"adtran-auth-permission:all",
"adtran-auth-permission:anonymous"
]
},
{
"name": "adtran-export-data-service",
"permission": [
"adtran-export-data-service:export-data-service"
]
},
{
"name": "adtran-cloud-platform-profiles-gfast-types",
"permission": []
},
{
"name": "adtran-cloud-platform-profiles-service",
"permission": []
},
{
"name": "adtran-cloud-platform-topics",
"permission": [
"adtran-cloud-platform-topics:configure-topics",
"adtran-cloud-platform-topics:read-topics"
]
},
{
"name": "adtran-captive-portal-aoe",
"permission": []
},
{
"name": "adtran-cloud-platform-profiles-voice-protocol",
"permission": []
},
{
"name": "adtran-cloud-platform-profiles-multicast",
"permission": []
},
{
"name": "adtran-cloud-platform-jobs",
"permission": [
"adtran-cloud-platform-jobs:read-adtn-cld-pfrm-job",
"adtran-cloud-platform-jobs:modify-adtn-cld-pfrm-job"
]
},
{
"name": "adtran-cxui-vqm-data",
"permission": []
},
{
"name": "adtran-cp-profiles-gfast-channel-threshold-profile-body",
"permission": []
},
{
"name": "adtran-cloud-platform-software-upgrade-service",
"permission": [
"adtran-cloud-platform-software-upgrade-service:download-software",
"adtran-cloud-platform-software-upgrade-service:commit-software",
"adtran-cloud-platform-software-upgrade-service:activate-software",
"adtran-cloud-platform-software-upgrade-service:commit-and-activate-software",
"adtran-cloud-platform-software-upgrade-service:reboot-device"
]
},
{
"name": "adtran-ffui-settings",
"permission": [
"adtran-ffui-settings:modify-settings",
"adtran-ffui-settings:read-settings"
]
},
{
"name": "adtran-cloud-platform-server-coordination",
"permission": [
"adtran-cloud-platform-server-coordination:config-servers",
"adtran-cloud-platform-server-coordination:deploy-servers",
"adtran-cloud-platform-server-coordination:activate-servers",
"adtran-cloud-platform-server-coordination:undeploy-servers",
"adtran-cloud-platform-server-coordination:deactivate-servers",
"adtran-cloud-platform-server-coordination:delete-servers",
"adtran-cloud-platform-server-coordination:communicate-servers"
]
},
{
"name": "adtran-cloud-platform-job-upgrade",
"permission": []
},
{
"name": "adtran-captive-portal-service-work",
"permission": []
},
{
"name": "adtran-cloud-platform-uiworkflow-services-types",
"permission": []
},
{
"name": "adtran-captive-portal-service-profiles",
"permission": []
},
{
"name": "adtran-cp-profiles-gfast-handshake-profile-body",
"permission": []
},
{
"name": "adtran-cloud-platform-profiles-voice-dialing",
"permission": []
},
{
"name": "adtran-auth-tech-support",
"permission": [
"adtran-auth-tech-support:generate-tech-support-challenges"
]
},
{
"name": "adtran-cloud-platform-profiles-sip-trunk",
"permission": []
},
{
"name": "adtran-captive-portal-etos",
"permission": []
},
{
"name": "adtran-cloud-platform-profiles-diameter-route",
"permission": []
},
{
"name": "adtran-captive-portal-user-actions",
"permission": []
},
{
"name": "adtran-cloud-platform-profiles-pon-igmp",
"permission": []
},
{
"name": "adtran-auth-domain",
"permission": [
"adtran-auth-domain:modify-domains"
]
},
{
"name": "adtran-cloud-platform-settings-gfast",
"permission": []
},
{
"name": "adtran-cloud-platform-uiworkflow-topology",
"permission": [
"adtran-cloud-platform-uiworkflow-topology:read-uiworkflow-topology",
"adtran-cloud-platform-uiworkflow-topology:run-uiworkflow-topology"
]
},
{
"name": "adtran-cloud-platform-profiles-gfast",
"permission": []
},
{
"name": "adtran-cloud-platform-search-object-status",
"permission": []
},
{
"name": "adtran-device-proxy-notifications",
"permission": []
},
{
"name": "adtran-cloud-platform-management-domains",
"permission": [
"adtran-cloud-platform-management-domains:read-adtn-cld-pfrm-md",
"adtran-cloud-platform-management-domains:modify-adtn-cld-pfrm-md"
]
},
{
"name": "adtran-captive-portal-server-credentials",
"permission": []
},
{
"name": "adtran-dpoe-node",
"permission": []
},
{
"name": "adtran-cloud-platform-profiles-venet-interface",
"permission": []
},
{
"name": "adtran-cloud-platform-elasticsearch-rollover-indices",
"permission": [
"adtran-cloud-platform-elasticsearch-rollover-indices:rollover-cron-update",
"adtran-cloud-platform-elasticsearch-rollover-indices:read-adtn-cld-pfrm-es-rlvr-indcs",
"adtran-cloud-platform-elasticsearch-rollover-indices:modify-adtn-cld-pfrm-es-rlvr-indcs"
]
},
{
"name": "adtran-nms-inventory",
"permission": [
"adtran-nms-inventory:read-inventory"
]
},
{
"name": "adtran-cloud-platform-profiles-ethernet",
"permission": []
},
{
"name": "adtran-captive-portal-policers",
"permission": [
"adtran-captive-portal-policers:read-policer",
"adtran-captive-portal-policers:modify-policer"
]
},
{
"name": "adtran-cloud-platform-uiworkflow-management-domains-types",
"permission": []
},
{
"name": "adtran-ffui-workboards-yds",
"permission": [
"adtran-ffui-workboards-yds:modify-workboards",
"adtran-ffui-workboards-yds:read-workboards"
]
},
{
"name": "adtran-cloud-platform-event-workflow",
"permission": [
"adtran-cloud-platform-event-workflow:event-read",
"adtran-cloud-platform-event-workflow:event-write",
"adtran-cloud-platform-event-workflow:event-clear",
"adtran-cloud-platform-event-workflow:read-event-workflow-transitions"
]
},
{
"name": "adtran-cloud-platform-connections-yds",
"permission": []
},
{
"name": "adtran-cloud-platform-hardware",
"permission": [
"adtran-cloud-platform-hardware:read-profile"
]
},
{
"name": "adtran-yang-datastore",
"permission": [
"adtran-yang-datastore:read-yang-model",
"adtran-yang-datastore:write-yang-model"
]
},
{
"name": "adtran-vssm-gx-subscriber-data",
"permission": [
"adtran-vssm-gx-subscriber-data:read-subscriber-data"
]
},
{
"name": "adtran-cloud-platform-dhcp-config",
"permission": [
"adtran-cloud-platform-dhcp-config:dhcp-config"
]
},
{
"name": "adtran-cloud-platform-uiworkflow-jobs",
"permission": [
"adtran-cloud-platform-uiworkflow-jobs:read-job",
"adtran-cloud-platform-uiworkflow-jobs:read-trigger",
"adtran-cloud-platform-uiworkflow-jobs:read-action",
"adtran-cloud-platform-uiworkflow-jobs:get-job-context",
"adtran-cloud-platform-uiworkflow-jobs:run-job",
"adtran-cloud-platform-uiworkflow-jobs:run-job-with-parameters",
"adtran-cloud-platform-uiworkflow-jobs:read-run-job-transitions"
]
},
{
"name": "adtran-cloud-platform-services",
"permission": [
"adtran-cloud-platform-services:read-service",
"adtran-cloud-platform-services:modify-service"
]
},
{
"name": "adtran-cloud-platform-software-upgrade-maintenance-service",
"permission": [
"adtran-cloud-platform-software-upgrade-maintenance-service:initiate-upgrade",
"adtran-cloud-platform-software-upgrade-maintenance-service:get-upgrade-status",
"adtran-cloud-platform-software-upgrade-maintenance-service:get-upgrade-summary-status"
]
},
{
"name": "adtran-cloud-platform-dhcp-subscriber-profile-mapping",
"permission": [
"adtran-cloud-platform-dhcp-subscriber-profile-mapping:modify-subscriber-profile-mapping",
"adtran-cloud-platform-dhcp-subscriber-profile-mapping:read-subscriber-profile-mapping"
]
},
{
"name": "adtran-cloud-platform-maintenance-service-work",
"permission": []
},
{
"name": "adtran-cloud-platform-profiles-pools",
"permission": [
"adtran-cloud-platform-profiles-pools:read-profile-pool",
"adtran-cloud-platform-profiles-pools:modify-profile-pools"
]
},
{
"name": "adtran-cloud-platform-y1731-session-measurement-report",
"permission": [
"adtran-cloud-platform-y1731-session-measurement-report:read-report"
]
},
{
"name": "adtran-cloud-platform-entity-transformation-gfast-types",
"permission": []
},
{
"name": "adtran-cloud-platform-uiworkflow-force-actions",
"permission": []
},
{
"name": "adtran-cp-profiles-gfast-vectoring-profile-body",
"permission": []
},
{
"name": "adtran-cloud-platform-profiles-voice-codec",
"permission": []
},
{
"name": "adtran-auth-user",
"permission": [
"adtran-auth-user:modify-users",
"adtran-auth-user:administer-users"
]
},
{
"name": "adtran-cloud-platform-bundles",
"permission": [
"adtran-cloud-platform-bundles:read-adtn-cld-pfrm-bndl",
"adtran-cloud-platform-bundles:modify-adtn-cld-pfrm-bndl"
]
},
{
"name": "adtran-cloud-platform-service-test-rfc2544",
"permission": [
"adtran-cloud-platform-service-test-rfc2544:read-rfc2544-tests",
"adtran-cloud-platform-service-test-rfc2544:run-test-rfc2544"
]
},
{
"name": "adtran-vssm-gx-handler",
"permission": [
"adtran-vssm-gx-handler:gx-handler"
]
},
{
"name": "adtran-cloud-platform-profiles-y1731-meg",
"permission": []
},
{
"name": "adtran-cxui-sip-stats",
"permission": []
},
{
"name": "adtran-device-proxy-snmp",
"permission": []
},
{
"name": "adtran-cloud-platform-profiles-ethernet-cfm",
"permission": []
},
{
"name": "adtran-nms-inventory-synchronization",
"permission": []
},
{
"name": "adtran-cloud-platform-profiles-device-connectivity",
"permission": []
},
{
"name": "adtran-cloud-platform-deferred-intents",
"permission": [
"adtran-cloud-platform-deferred-intents:read-deferred-intents"
]
},
{
"name": "adtran-cloud-platform-servers",
"permission": [
"adtran-cloud-platform-servers:read-adtn-cld-pfrm-srvr",
"adtran-cloud-platform-servers:modify-adtn-cld-pfrm-srvr"
]
},
{
"name": "adtran-cloud-platform-data-centers",
"permission": [
"adtran-cloud-platform-data-centers:read-adtn-cld-pfrm-data-ctr",
"adtran-cloud-platform-data-centers:modify-adtn-cld-pfrm-data-ctr"
]
},
{
"name": "adtran-cloud-platform-profiles-snmp",
"permission": []
},
{
"name": "adtran-captive-portal-activation-logs",
"permission": []
},
{
"name": "adtran-cloud-platform-profiles-vdsl",
"permission": []
},
{
"name": "adtran-dhcp-autoprov-info",
"permission": [
"adtran-dhcp-autoprov-info:read-adtn-dhcp-ap-info"
]
},
{
"name": "adtran-cloud-platform-business-service-management",
"permission": [
"adtran-cloud-platform-business-service-management:service-read",
"adtran-cloud-platform-business-service-management:service-write"
]
},
{
"name": "adtran-cloud-platform-profiles-service-segment",
"permission": []
},
{
"name": "adtran-cloud-platform-search-alarms",
"permission": []
},
{
"name": "adtran-cloud-platform-profiles-common-types",
"permission": []
},
{
"name": "adtran-cloud-platform-search-global-types",
"permission": []
},
{
"name": "adtran-cloud-platform-profiles-ancp",
"permission": []
},
{
"name": "adtran-cloud-platform-uiworkflow-credentials",
"permission": [
"adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls"
]
},
{
"name": "adtran-cloud-platform-plugin-ta5k-fttp-segment-data",
"permission": []
},
{
"name": "adtran-auth-config",
"permission": [
"adtran-auth-config:modify-config"
]
},
{
"name": "adtran-aoe-access",
"permission": []
},
{
"name": "adtran-cloud-platform-uiworkflow-servers",
"permission": [
"adtran-cloud-platform-uiworkflow-servers:read-uiworkflow-servers"
]
},
{
"name": "adtran-cloud-platform-devices-ngpon2",
"permission": []
},
{
"name": "adtran-cloud-platform-uiworkflow-interface-types",
"permission": []
},
{
"name": "adtran-cloud-platform-search-accounting-logs",
"permission": []
},
{
"name": "adtran-cloud-platform-search",
"permission": [
"adtran-cloud-platform-search:execute-search",
"adtran-cloud-platform-search:administer-search"
]
},
{
"name": "adtran-cp-profiles-gfast-retransmission-profile-body",
"permission": []
},
{
"name": "adtran-cloud-platform-profiles-scoped-policing",
"permission": []
},
{
"name": "adtran-manifests",
"permission": [
"adtran-manifests:read-adtn-manif"
]
},
{
"name": "adtran-cloud-platform-uiworkflow-bundles-types",
"permission": []
},
{
"name": "adtran-cloud-platform-profiles-entity-transformation",
"permission": []
},
{
"name": "adtran-cloud-platform-vssm-diameter-statistics",
"permission": [
"adtran-cloud-platform-vssm-diameter-statistics:diameter-stats-perm"
]
},
{
"name": "adtran-cloud-platform-table",
"permission": []
},
{
"name": "adtran-cloud-platform-services-sip",
"permission": []
},
{
"name": "adtran-captive-portal-sla-profiles",
"permission": [
"adtran-captive-portal-sla-profiles:read-sla-profile",
"adtran-captive-portal-sla-profiles:modify-sla-profile"
]
},
{
"name": "adtran-cloud-platform-ancp",
"permission": []
},
{
"name": "adtran-cloud-platform-uiworkflow-data-center-types",
"permission": [
"adtran-cloud-platform-uiworkflow-data-center-types:read-uiworkflow-data-center-type"
]
},
{
"name": "adtran-cloud-platform-diagnostic-data-maintenance-service",
"permission": [
"adtran-cloud-platform-diagnostic-data-maintenance-service:get-diagnostic-job-info"
]
},
{
"name": "adtran-cloud-platform-uiworkflow-management-domains",
"permission": [
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domain-types",
"adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domains"
]
},
{
"name": "adtran-captive-portal-wholesale-activations",
"permission": []
},
{
"name": "adtran-auth-token",
"permission": []
},
{
"name": "adtran-auth-config-external",
"permission": [
"adtran-auth-config-external:modify-config-ext"
]
},
{
"name": "adtran-cloud-platform-trap-hosts",
"permission": []
},
{
"name": "adtran-cloud-platform-uiworkflow-subscribers",
"permission": [
"adtran-cloud-platform-uiworkflow-subscribers:read-uiworkflow-subscribers",
"adtran-cloud-platform-uiworkflow-subscribers:filter-uiworkflow-subscriber-resources"
]
},
{
"name": "adtran-auth-accounting",
"permission": [
"adtran-auth-accounting:read-accounting-logs"
]
},
{
"name": "adtran-cloud-platform-uiworkflow-devices-gfast",
"permission": []
},
{
"name": "adtran-cloud-platform-profiles-tcont-name",
"permission": []
},
{
"name": "adtran-cloud-platform-subscriber-policy",
"permission": [
"adtran-cloud-platform-subscriber-policy:modify-subs-policy",
"adtran-cloud-platform-subscriber-policy:read-subs-policy"
]
},
{
"name": "adtran-captive-portal-content-providers",
"permission": [
"adtran-captive-portal-content-providers:read-content-provider",
"adtran-captive-portal-content-providers:modify-content-provider"
]
},
{
"name": "adtran-cloud-platform-device-upgrade",
"permission": []
},
{
"name": "adtran-captive-portal-ncommand",
"permission": []
},
{
"name": "adtran-cloud-platform-devices",
"permission": [
"adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev",
"adtran-cloud-platform-devices:modify-adtn-cld-pfrm-dev"
]
},
{
"name": "adtran-cp-profiles-gfast-rfi-profile-body",
"permission": []
},
{
"name": "adtran-nbi-pm",
"permission": [
"adtran-nbi-pm:pm-config",
"adtran-nbi-pm:pm-read"
]
},
{
"name": "adtran-cloud-platform-profiles-system",
"permission": []
},
{
"name": "adtran-cloud-platform-subscribers",
"permission": [
"adtran-cloud-platform-subscribers:read-adtn-cld-pfrm-subs",
"adtran-cloud-platform-subscribers:modify-adtn-cld-pfrm-subs"
]
},
{
"name": "adtran-cloud-platform-search-usage-tracking-data",
"permission": []
},
{
"name": "adtran-cloud-platform-profiles",
"permission": [
"adtran-cloud-platform-profiles:config-profile",
"adtran-cloud-platform-profiles:read-profile"
]
},
{
"name": "adtran-cloud-platform-profiles-aes-config",
"permission": []
},
{
"name": "adtran-cp-profiles-gfast-tdd-profile-body",
"permission": []
},
{
"name": "adtran-cassandra-manager",
"permission": []
},
{
"name": "adtran-cloud-platform-ui-inspect",
"permission": [
"adtran-cloud-platform-ui-inspect:run-request",
"adtran-cloud-platform-ui-inspect:run-action"
]
},
{
"name": "adtran-cloud-platform-mqtt-yds",
"permission": []
},
{
"name": "adtran-cloud-platform-devices-gfast",
"permission": []
},
{
"name": "adtran-cloud-platform-profiles-custom-index",
"permission": []
},
{
"name": "adtran-cloud-platform-alarm-logger",
"permission": [
"adtran-cloud-platform-alarm-logger:read-alarm-logs"
]
},
{
"name": "adtran-server-proxy-by-name",
"permission": [
"adtran-server-proxy-by-name:server-read"
]
},
{
"name": "adtran-cloud-platform-labels",
"permission": [
"adtran-cloud-platform-labels:read-labels",
"adtran-cloud-platform-labels:modify-labels"
]
},
{
"name": "adtran-cloud-platform-profiles-default-host-interface",
"permission": []
},
{
"name": "adtran-cloud-platform-profiles-allocation",
"permission": []
},
{
"name": "adtran-device-proxy-snmp-transactions",
"permission": []
},
{
"name": "adtran-cloud-platform-profiles-traffic-management",
"permission": []
},
{
"name": "adtran-cloud-platform-uiworkflow-devices-ngpon2",
"permission": []
},
{
"name": "adtran-cloud-platform-event-description",
"permission": [
"adtran-cloud-platform-event-description:configure-event-description",
"adtran-cloud-platform-event-description:read-event-description"
]
},
{
"name": "adtran-cloud-platform-proxy-service",
"permission": [
"adtran-cloud-platform-proxy-service:device-read",
"adtran-cloud-platform-proxy-service:device-write",
"adtran-cloud-platform-proxy-service:mount-point-read",
"adtran-cloud-platform-proxy-service:server-read",
"adtran-cloud-platform-proxy-service:server-write"
]
},
{
"name": "adtran-cloud-platform-plugin",
"permission": [
"adtran-cloud-platform-plugin:reload-plugins",
"adtran-cloud-platform-plugin:get-plugins"
]
},
{
"name": "adtran-cloud-platform-information",
"permission": [
"adtran-cloud-platform-information:read-information"
]
},
{
"name": "adtran-cloud-platform-uiworkflow-jobs-types",
"permission": []
},
{
"name": "adtran-cloud-platform-interfaces",
"permission": [
"adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int",
"adtran-cloud-platform-interfaces:modify-adtn-cld-pfrm-int"
]
},
{
"name": "adtran-cloud-platform-profiles-user",
"permission": []
},
{
"name": "adtran-cloud-platform-search-all-labels",
"permission": []
},
{
"name": "adtran-cloud-platform-profiles-legacy-gpon",
"permission": []
},
{
"name": "adtran-cloud-platform-uiworkflow-interfaces",
"permission": [
"adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interface-type",
"adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interfaces",
"adtran-cloud-platform-uiworkflow-interfaces:filter-uiworkflow-interface-resources",
"adtran-cloud-platform-uiworkflow-interfaces:filter-uiworkflow-physical-resources"
]
},
{
"name": "adtran-cloud-platform-profiles-melt",
"permission": []
},
{
"name": "adtran-cloud-platform-profiles-lci-policy",
"permission": []
},
{
"name": "adtran-automation-portal-residential-activation",
"permission": []
},
{
"name": "adtran-cp-profiles-gfast-upstream-power-back-off-profile-body",
"permission": []
},
{
"name": "adtran-cp-profiles-gfast-data-rate-profile-body",
"permission": []
},
{
"name": "adtran-captive-portal-dpus",
"permission": []
},
{
"name": "adtran-cloud-platform-connection-monitor",
"permission": [
"adtran-cloud-platform-connection-monitor:aggregate-sessions-count"
]
},
{
"name": "adtran-cloud-platform-system-monitor",
"permission": [
"adtran-cloud-platform-system-monitor:read-system-monitor-node-status"
]
},
{
"name": "adtran-cp-profiles-gfast-line-spectrum-profile-body",
"permission": []
},
{
"name": "adtran-cloud-platform-dfn-route-configuration",
"permission": [
"adtran-cloud-platform-dfn-route-configuration:modify-dfn-rt-configuration",
"adtran-cloud-platform-dfn-route-configuration:read-dfn-rt-configuration"
]
},
{
"name": "adtran-cloud-platform-uiworkflow-inspect",
"permission": [
"adtran-cloud-platform-uiworkflow-inspect:inspect-uiworkflow-devices",
"adtran-cloud-platform-uiworkflow-inspect:inspect-uiworkflow-profiles",
"adtran-cloud-platform-uiworkflow-inspect:inspect-uiworkflow-interfaces",
"adtran-cloud-platform-uiworkflow-inspect:inspect-uiworkflow-server",
"adtran-cloud-platform-uiworkflow-inspect:manage-uiworkflow-dpu"
]
},
{
"name": "adtran-cloud-platform-profiles-traffic-management-types",
"permission": []
},
{
"name": "adtran-cloud-platform-uiworkflow-devices",
"permission": [
"adtran-cloud-platform-uiworkflow-devices:read-uiworkflow-devices"
]
},
{
"name": "adtran-cloud-platform-uiworkflow-behaviors",
"permission": [
"adtran-cloud-platform-uiworkflow-behaviors:run-uiworkflow-behavior",
"adtran-cloud-platform-uiworkflow-behaviors:read-uiworkflow-behavior"
]
},
{
"name": "adtran-cloud-platform-base-configurations",
"permission": [
"adtran-cloud-platform-base-configurations:read-adtn-cld-pfrm-bc",
"adtran-cloud-platform-base-configurations:modify-adtn-cld-pfrm-bc"
]
},
{
"name": "adtran-captive-portal-wholesale-helpers",
"permission": [
"adtran-captive-portal-wholesale-helpers:configure-interface",
"adtran-captive-portal-wholesale-helpers:create-dpu-mgmt-svcs-for-l2s",
"adtran-captive-portal-wholesale-helpers:delete-dpu-mgmt-svcs-for-l2s",
"adtran-captive-portal-wholesale-helpers:commission-dpu",
"adtran-captive-portal-wholesale-helpers:decommission-dpu",
"adtran-captive-portal-wholesale-helpers:create-l2s-device-mgmt-svcs",
"adtran-captive-portal-wholesale-helpers:delete-l2s-device-mgmt-svcs",
"adtran-captive-portal-wholesale-helpers:commission-l2s-device",
"adtran-captive-portal-wholesale-helpers:decommission-l2s-device",
"adtran-captive-portal-wholesale-helpers:create-content-provider",
"adtran-captive-portal-wholesale-helpers:delete-content-provider",
"adtran-captive-portal-wholesale-helpers:create-l2s-service",
"adtran-captive-portal-wholesale-helpers:delete-l2s-service",
"adtran-captive-portal-wholesale-helpers:create-dpu-service",
"adtran-captive-portal-wholesale-helpers:delete-dpu-service",
"adtran-captive-portal-wholesale-helpers:activate-service",
"adtran-captive-portal-wholesale-helpers:deactivate-service",
"adtran-captive-portal-wholesale-helpers:add-ont",
"adtran-captive-portal-wholesale-helpers:modify-ont",
"adtran-captive-portal-wholesale-helpers:remove-ont",
"adtran-captive-portal-wholesale-helpers:replace-ont",
"adtran-captive-portal-wholesale-helpers:create-ses-service",
"adtran-captive-portal-wholesale-helpers:delete-ses-service",
"adtran-captive-portal-wholesale-helpers:create-pon-system",
"adtran-captive-portal-wholesale-helpers:update-pon-system",
"adtran-captive-portal-wholesale-helpers:update-pon",
"adtran-captive-portal-wholesale-helpers:delete-pon-system",
"adtran-captive-portal-wholesale-helpers:delete-channel-partition",
"adtran-captive-portal-wholesale-helpers:get-pons-of-channel-partition"
]
},
{
"name": "adtran-cp-profiles-gfast-reinitialization-policy-profile-body",
"permission": []
},
{
"name": "adtran-cloud-platform-subscriber-accounting",
"permission": [
"adtran-cloud-platform-subscriber-accounting:write-config",
"adtran-cloud-platform-subscriber-accounting:read-config"
]
},
{
"name": "adtran-cloud-platform-profiles-file-transfer-server",
"permission": []
},
{
"name": "adtran-cp-profiles-gfast-fast-retrain-policy-profile-body",
"permission": []
},
{
"name": "adtran-nbi-ipaa-ssh",
"permission": [
"adtran-nbi-ipaa-ssh:ipaa-config-ssh"
]
},
{
"name": "adtran-system-config",
"permission": [
"adtran-system-config:modify-config"
]
},
{
"name": "adtran-cloud-platform-profiles-voice-media",
"permission": []
},
{
"name": "adtran-cloud-platform-search-by-label",
"permission": []
},
{
"name": "adtran-cp-profiles-gfast-fast-rate-adaptation-profile-body",
"permission": []
},
{
"name": "adtran-cloud-platform-profiles-device-software-upgrade",
"permission": []
},
{
"name": "adtran-vssm-gx-session",
"permission": [
"adtran-vssm-gx-session:gx-session"
]
},
{
"name": "adtran-cloud-platform-uiworkflow-services-sip",
"permission": []
},
{
"name": "adtran-cloud-platform-restconf-streams",
"permission": [
"adtran-cloud-platform-restconf-streams:stream-read"
]
},
{
"name": "adtran-cloud-platform-dhcp-lease",
"permission": [
"adtran-cloud-platform-dhcp-lease:read-dhcp-lease"
]
},
{
"name": "adtran-cloud-platform-uiworkflow-inventory",
"permission": []
},
{
"name": "adtran-cloud-platform-plugin-adtn-1u-olt-yds-data",
"permission": []
},
{
"name": "adtran-cloud-platform-profiles-melt-types",
"permission": []
},
{
"name": "adtran-cloud-platform-profiles-alarm",
"permission": []
},
{
"name": "adtran-cloud-platform-device-credentials",
"permission": [
"adtran-cloud-platform-device-credentials:read-adtn-cld-pfrm-dev-crdls",
"adtran-cloud-platform-device-credentials:modify-adtn-cld-pfrm-dev-crdls"
]
},
{
"name": "adtran-cloud-platform-uiworkflow-services",
"permission": [
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-service-profiles",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-services",
"adtran-cloud-platform-uiworkflow-services:read-uiworkflow-content-providers"
]
},
{
"name": "adtran-cloud-platform-search-object-filter",
"permission": []
},
{
"name": "adtran-cp-profiles-gfast-vdsl-crosstalk-detection-profile-body",
"permission": []
},
{
"name": "adtran-cloud-platform-uiworkflow-servers-types",
"permission": []
},
{
"name": "adtran-trap-forwarder",
"permission": [
"adtran-trap-forwarder:trap-config-read",
"adtran-trap-forwarder:trap-config-write"
]
},
{
"name": "adtran-cloud-platform-plugin-service-segment-data",
"permission": []
},
{
"name": "adtran-device-proxy",
"permission": [
"adtran-device-proxy:device-read",
"adtran-device-proxy:device-write",
"adtran-device-proxy:device-execute",
"adtran-device-proxy:server-write"
]
},
{
"name": "adtran-cloud-platform-device-backup",
"permission": [
"adtran-cloud-platform-device-backup:read-adtn-cld-pfrm-dev-bkup",
"adtran-cloud-platform-device-backup:modify-adtn-cld-pfrm-dev-bkup"
]
},
{
"name": "adtran-ffui-applications",
"permission": [
"adtran-ffui-applications:read-apps-info",
"adtran-ffui-applications:write-apps-info"
]
},
{
"name": "adtran-device-proxy-rest",
"permission": []
},
{
"name": "adtran-captive-portal-service-transition",
"permission": [
"adtran-captive-portal-service-transition:read-service-transitions"
]
},
{
"name": "adtran-cloud-platform-enablement-adapter",
"permission": [
"adtran-cloud-platform-enablement-adapter:run-ebmt-adpt-trap-receiver"
]
},
{
"name": "adtran-rest-extensions",
"permission": []
},
{
"name": "adtran-cloud-platform-search-performance-monitoring-data",
"permission": []
},
{
"name": "adtran-cp-profiles-gfast-noise-margin-profile-body",
"permission": []
},
{
"name": "adtran-cloud-platform-dhcp-profiles",
"permission": [
"adtran-cloud-platform-dhcp-profiles:modify-dhcp-profile",
"adtran-cloud-platform-dhcp-profiles:read-dhcp-profile"
]
},
{
"name": "adtran-cloud-platform-plugin-adtn-1u-olt-segment-data",
"permission": []
},
{
"name": "adtran-nbi-inventory",
"permission": []
},
{
"name": "adtran-dhcp-ont-activations",
"permission": [
"adtran-dhcp-ont-activations:read-adtn-dhcp-ont-act"
]
},
{
"name": "adtran-cloud-platform-service-test-y1731",
"permission": [
"adtran-cloud-platform-service-test-y1731:read-y1731-tests",
"adtran-cloud-platform-service-test-y1731:run-test-y1731",
"adtran-cloud-platform-service-test-y1731:run-graph-y1731"
]
},
{
"name": "adtran-cloud-platform-profiles-voice-call-feature",
"permission": []
},
{
"name": "adtran-cloud-platform-services-cfm",
"permission": []
},
{
"name": "adtran-cloud-platform-profiles-multicast-vpn",
"permission": []
},
{
"name": "adtran-cxui-device",
"permission": []
},
{
"name": "adtran-cloud-platform-device-types",
"permission": []
},
{
"name": "adtran-cloud-platform-profiles-external-sensor-configuration",
"permission": []
},
{
"name": "adtran-cxui-types",
"permission": [
"adtran-cxui-types:read-adtn-cxui-dev",
"adtran-cxui-types:read-adtn-cxui-dev-stats",
"adtran-cxui-types:modify-adtn-cxui-dev",
"adtran-cxui-types:read-adtn-cxui-vqm",
"adtran-cxui-types:read-adtn-cxui-sip-stats"
]
},
{
"name": "adtran-launchpad-login",
"permission": [
"adtran-launchpad-login:modify-login-page",
"adtran-launchpad-login:modify-browser-page"
]
},
{
"name": "adtran-captive-portal-business-activations",
"permission": []
},
{
"name": "adtran-cloud-platform-profiles-grouping",
"permission": []
},
{
"name": "adtran-cloud-platform-restconf-service",
"permission": [
"adtran-cloud-platform-restconf-service:read-permission",
"adtran-cloud-platform-restconf-service:open-session",
"adtran-cloud-platform-restconf-service:close-session",
"adtran-cloud-platform-restconf-service:read-session",
"adtran-cloud-platform-restconf-service:read-config",
"adtran-cloud-platform-restconf-service:write-config",
"adtran-cloud-platform-restconf-service:delete-config",
"adtran-cloud-platform-restconf-service:subscribe-notifications",
"adtran-cloud-platform-restconf-service:unsubscribe-notifications",
"adtran-cloud-platform-restconf-service:read-schema",
"adtran-cloud-platform-restconf-service:reestablish-session",
"adtran-cloud-platform-restconf-service:get-all-device-sessions",
"adtran-cloud-platform-restconf-service:get-all-device-notifications",
"adtran-cloud-platform-restconf-service:reboot-device",
"adtran-cloud-platform-restconf-service:execute-rpc"
]
},
{
"name": "adtran-cloud-platform-devices-activate",
"permission": []
},
{
"name": "adtran-cloud-platform-dfn-peer-configuration",
"permission": [
"adtran-cloud-platform-dfn-peer-configuration:modify-dfn-pr-configuration",
"adtran-cloud-platform-dfn-peer-configuration:read-dfn-pr-configuration"
]
},
{
"name": "adtran-cloud-platform-uiworkflow-part-numbers",
"permission": [
"adtran-cloud-platform-uiworkflow-part-numbers:read-uiworkflow-part-number"
]
},
{
"name": "adtran-cloud-platform-settings-deferred-intent",
"permission": []
},
{
"name": "adtran-cloud-platform-overrides",
"permission": []
},
{
"name": "adtran-cloud-platform-uiworkflow-data-centers",
"permission": [
"adtran-cloud-platform-uiworkflow-data-centers:read-uiworkflow-data-centers"
]
},
{
"name": "adtran-cloud-platform-profiles-authentication",
"permission": []
},
{
"name": "adtran-feature-flags",
"permission": [
"adtran-feature-flags:config-flag"
]
},
{
"name": "adtran-cloud-platform-profiles-conditional",
"permission": []
},
{
"name": "adtran-cloud-platform-profiles-service-shaper",
"permission": []
},
{
"name": "adtran-cloud-platform-subscriber-session-status",
"permission": [
"adtran-cloud-platform-subscriber-session-status:read-subscriber-session"
]
},
{
"name": "adtran-auth-group",
"permission": [
"adtran-auth-group:modify-groups"
]
},
{
"name": "adtran-cloud-platform-dfn-configuration",
"permission": [
"adtran-cloud-platform-dfn-configuration:modify-dfn-configuration",
"adtran-cloud-platform-dfn-configuration:read-dfn-configuration"
]
},
{
"name": "adtran-ffui-types",
"permission": []
},
{
"name": "adtran-vssm-radius-config",
"permission": []
},
{
"name": "adtran-file-transfer",
"permission": [
"adtran-file-transfer:read-adtn-file-xfer-sftp-cfg",
"adtran-file-transfer:modify-adtn-file-xfer-sftp-cfg"
]
},
{
"name": "adtran-cloud-platform-event-enrichment-helper",
"permission": [
"adtran-cloud-platform-event-enrichment-helper:event-enrichment-helper"
]
},
{
"name": "adtran-cloud-platform-profiles-scoped-shaping",
"permission": []
},
{
"name": "adtran-cloud-platform-uiworkflow-bundles",
"permission": [
"adtran-cloud-platform-uiworkflow-bundles:read-uiworkflow-bundle-type",
"adtran-cloud-platform-uiworkflow-bundles:read-uiworkflow-bundles",
"adtran-cloud-platform-uiworkflow-bundles:filter-uiworkflow-bundle-resources"
]
},
{
"name": "adtran-cloud-platform-profiles-event-config",
"permission": []
},
{
"name": "adtran-pma-adapter",
"permission": []
},
{
"name": "adtran-cloud-platform-credentials",
"permission": [
"adtran-cloud-platform-credentials:read-adtn-cld-pfrm-crdls",
"adtran-cloud-platform-credentials:modify-adtn-cld-pfrm-crdls"
]
},
{
"name": "adtran-cloud-platform-plugin-adtn-602x-onu-segment-data",
"permission": []
},
{
"name": "adtran-cloud-platform-profiles-tcont",
"permission": []
},
{
"name": "adtran-cloud-platform-plugin-device-netconf-lock-state",
"permission": []
},
{
"name": "adtran-cloud-platform-job-config",
"permission": []
},
{
"name": "adtran-cloud-platform-deferred-intent-service",
"permission": [
"adtran-cloud-platform-deferred-intent-service:execute-intent-operation"
]
},
{
"name": "adtran-cloud-platform-types",
"permission": []
},
{
"name": "adtran-cloud-platform-usage-report",
"permission": []
},
{
"name": "adtran-vssm-gx-config",
"permission": [
"adtran-vssm-gx-config:read-gx-apn-config"
]
},
{
"name": "adtran-cloud-platform-sse-client",
"permission": []
},
{
"name": "adtran-cloud-platform-settings",
"permission": [
"adtran-cloud-platform-settings:read-adtn-cld-pfrm-set",
"adtran-cloud-platform-settings:modify-adtn-cld-pfrm-set"
]
},
{
"name": "adtran-cloud-platform-uiworkflow-device-credentials",
"permission": [
"adtran-cloud-platform-uiworkflow-device-credentials:read-adtn-cld-pfrm-uiw-dev-crdls"
]
},
{
"name": "adtran-cloud-platform-bulk-alarm-count",
"permission": []
},
{
"name": "adtran-cloud-platform-uiworkflow-services-cfm",
"permission": []
},
{
"name": "adtran-cloud-platform-profiles-subscriber-access-control",
"permission": []
},
{
"name": "adtran-cloud-platform-uiworkflow-devices-activate",
"permission": []
},
{
"name": "adtran-cloud-platform-profiles-configuration-storage",
"permission": []
},
{
"name": "adtran-cloud-platform-subscriber-session-manager",
"permission": [
"adtran-cloud-platform-subscriber-session-manager:config-sessions",
"adtran-cloud-platform-subscriber-session-manager:read-subscribers"
]
},
{
"name": "adtran-device-connectivity",
"permission": []
},
{
"name": "adtran-ffui-workboards",
"permission": [
"adtran-ffui-workboards:modify-workboards",
"adtran-ffui-workboards:read-workboards"
]
},
{
"name": "adtran-cxui-vqm-interface",
"permission": []
},
{
"name": "adtran-cloud-platform-vssm-gx-statistics",
"permission": [
"adtran-cloud-platform-vssm-gx-statistics:gx-stats-perm"
]
},
{
"name": "adtran-cloud-platform-profiles-pon-multicast",
"permission": []
},
{
"name": "adtran-nbi-sysmon",
"permission": [
"adtran-nbi-sysmon:sysmon-config",
"adtran-nbi-sysmon:sysmon-read"
]
},
{
"name": "adtran-cloud-platform-marshal-plugins",
"permission": []
},
{
"name": "adtran-billing-system-management",
"permission": []
},
{
"name": "adtran-cloud-platform-inventory",
"permission": []
},
{
"name": "adtran-cxui-device-stats",
"permission": []
},
{
"name": "adtran-nbi-ipaa",
"permission": [
"adtran-nbi-ipaa:ipaa-config"
]
},
{
"name": "adtran-cloud-platform-uiworkflow-profiles",
"permission": [
"adtran-cloud-platform-uiworkflow-profiles:read-profile"
]
},
{
"name": "adtran-cloud-platform-network-walk-job",
"permission": []
},
{
"name": "adtran-cloud-platform-profiles-pon-port",
"permission": []
},
{
"name": "adtran-cloud-platform-management-domain-coordination",
"permission": [
"adtran-cloud-platform-management-domain-coordination:config-mgmt-domains",
"adtran-cloud-platform-management-domain-coordination:deploy-mgmt-domains",
"adtran-cloud-platform-management-domain-coordination:activate-mgmt-domains",
"adtran-cloud-platform-management-domain-coordination:delete-mgmt-domains",
"adtran-cloud-platform-management-domain-coordination:undeploy-mgmt-domains",
"adtran-cloud-platform-management-domain-coordination:deactivate-mgmt-domains"
]
},
{
"name": "adtran-cloud-platform-search-labels-by-object",
"permission": []
},
{
"name": "adtran-cloud-platform-maintenance-services",
"permission": [
"adtran-cloud-platform-maintenance-services:execute-action",
"adtran-cloud-platform-maintenance-services:read-action-status"
]
},
{
"name": "adtran-captive-portal-services",
"permission": [
"adtran-captive-portal-services:read-service",
"adtran-captive-portal-services:modify-service",
"adtran-captive-portal-services:read-service-status",
"adtran-captive-portal-services:configure-service",
"adtran-captive-portal-services:deploy-service",
"adtran-captive-portal-services:activate-service",
"adtran-captive-portal-services:deactivate-service",
"adtran-captive-portal-services:undeploy-service",
"adtran-captive-portal-services:delete-service",
"adtran-captive-portal-services:find-service"
]
},
{
"name": "adtran-cloud-platform-profiles-device-software",
"permission": []
},
{
"name": "adtran-device-proxy-by-name",
"permission": []
},
{
"name": "adtran-cp-profiles-gfast-line-threshold-profile-body",
"permission": []
},
{
"name": "adtran-cloud-platform-netconf-client-service",
"permission": [
"adtran-cloud-platform-netconf-client-service:open-session",
"adtran-cloud-platform-netconf-client-service:close-session",
"adtran-cloud-platform-netconf-client-service:read-session",
"adtran-cloud-platform-netconf-client-service:read-config",
"adtran-cloud-platform-netconf-client-service:write-config",
"adtran-cloud-platform-netconf-client-service:delete-config",
"adtran-cloud-platform-netconf-client-service:subscribe-notifications",
"adtran-cloud-platform-netconf-client-service:unsubscribe-notifications",
"adtran-cloud-platform-netconf-client-service:read-schema",
"adtran-cloud-platform-netconf-client-service:reestablish-session",
"adtran-cloud-platform-netconf-client-service:get-all-device-sessions",
"adtran-cloud-platform-netconf-client-service:reboot-device",
"adtran-cloud-platform-netconf-client-service:execute-rpc"
]
},
{
"name": "adtran-captive-portal-types",
"permission": [
"adtran-captive-portal-types:read-server-credentials",
"adtran-captive-portal-types:modify-server-credentials",
"adtran-captive-portal-types:read-activation-logs",
"adtran-captive-portal-types:read-user-logs",
"adtran-captive-portal-types:activate-service"
]
},
{
"name": "adtran-dhcp-leases",
"permission": [
"adtran-dhcp-leases:read-adtn-dhcp-lease"
]
},
{
"name": "adtran-cloud-platform-search-global",
"permission": []
},
{
"name": "adtran-cloud-platform-event-config",
"permission": []
},
{
"name": "adtran-cloud-platform-diameter-config",
"permission": [
"adtran-cloud-platform-diameter-config:diameter-config"
]
}
]
}
}
}
}
},
"deprecated": false
}
},
"/operations/adtran-auth-user:create-user": {
"post": {
"tags": [
"AAA Users"
],
"summary": "Create User Account",
"description": "Create a new user by supplying a **unique** username and a password for authentication.\n\n| Attribute | Description |\n| --- | --- |\n| username | **Required:** A unique username of the user. |\n| password | **Required:** Password which will authenticate the user. |\n| expiration-mode | **Optional** Describes how to handle the expiration date on the newly created account. If omitted, this will default to the configured value in the above `Modifying Password Security Setting` request. Possible Values: expire-now: Create the account as already expired expire-policy: Set the expiration date according to configured system policy expire-never: Create an account which will never expire |",
"operationId": "CreateUserAccount",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateUserAccountRequest"
},
"example": {
"username": "SampleUser",
"password": "SuperSecret1!"
}
}
},
"required": true
},
"responses": {
"409": {
"description": "Conflict",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 08 May 2020 10:49:17 GMT"
},
"example": "Fri, 08 May 2020 10:49:17 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "34"
},
"example": "34"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/CreateUserAccount-Useralreadyexists1"
},
"example": {
"message": "User already exists."
}
}
}
},
"201": {
"description": "Created",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 05 May 2020 11:31:13 GMT"
},
"example": "Tue, 05 May 2020 11:31:13 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "0"
},
"example": "0"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {}
},
"400": {
"description": "Bad Request",
"headers": {
"access-control-allow-origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"content-length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "145"
},
"example": "145"
}
}
},
"content-type": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "application/json; charset=UTF-8"
},
"example": "application/json; charset=UTF-8"
}
}
},
"date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 05 May 2020 09:22:24 GMT"
},
"example": "Tue, 05 May 2020 09:22:24 GMT"
}
}
},
"x-frame-options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateUserAccount-MissingMandatoryparam1"
},
"example": {
"message": "Invalid JSON Content Fields Provided: No usable value for password\nDid not find value which can be converted into java.lang.String"
}
}
}
}
},
"deprecated": false
}
},
"/operations/adtran-auth-user:override-password": {
"post": {
"tags": [
"AAA Users"
],
"summary": "Override Password",
"description": "Overrides user's password used for authentication. It can only be used by the ADMIN user.\n\n| Attribute | Description |\n| --- | --- |\n| username | **Required:** A unique username of the user. |\n| password | **Required:** New password which will authenticate the user. |",
"operationId": "OverridePassword",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OverridePasswordRequest"
},
"example": {
"username": "SampleUser",
"password": "SuperSecret1!"
}
}
},
"required": true
},
"responses": {
"404": {
"description": "Not Found",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 08 May 2020 10:50:54 GMT"
},
"example": "Fri, 08 May 2020 10:50:54 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "46"
},
"example": "46"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/OverridePassword-Userdoesnotexist1"
},
"example": {
"message": "User Test-Accoun does not exist."
}
}
}
},
"200": {
"description": "OK",
"headers": {
"access-control-allow-origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"content-length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "0"
},
"example": "0"
}
}
},
"date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 05 May 2020 09:24:50 GMT"
},
"example": "Tue, 05 May 2020 09:24:50 GMT"
}
}
},
"x-frame-options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {}
}
},
"deprecated": false
}
},
"/operations/adtran-auth-user:reset-password": {
"post": {
"tags": [
"AAA Users"
],
"summary": "Reset Password",
"description": "Allows a user to reset password in case the user has forgotten the password or it has expired.\n\n| Attribute | Description |\n| --- | --- |\n| username | **Required:** Username for which password reset request is initiated. |\n| old-password | **Required:** Old password to authenticate the user. |\n| new-password | **Required:** New password which will replace old-password. |",
"operationId": "ResetPassword",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResetPasswordRequest"
},
"example": {
"username": "SampleUser",
"old-password": "SuperSecret1!",
"new-password": "SuperSecret2!"
}
}
},
"required": true
},
"responses": {
"401": {
"description": "Unauthorized",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 08 May 2020 10:51:59 GMT"
},
"example": "Fri, 08 May 2020 10:51:59 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "159"
},
"example": "159"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/ResetPassword-Invalidusernameorpassword1"
},
"example": {
"message": "Supplied username or password is incorrect. Please try again. Multiple failed login attempts may result in your account being temporarily locked."
}
}
}
},
"200": {
"description": "OK",
"headers": {
"access-control-allow-origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"content-length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "0"
},
"example": "0"
}
}
},
"date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 05 May 2020 09:25:19 GMT"
},
"example": "Tue, 05 May 2020 09:25:19 GMT"
}
}
},
"x-frame-options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {}
},
"400": {
"description": "Bad Request",
"headers": {
"access-control-allow-origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"content-length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "51"
},
"example": "51"
}
}
},
"content-type": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "application/json; charset=UTF-8"
},
"example": "application/json; charset=UTF-8"
}
}
},
"date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 05 May 2020 09:26:03 GMT"
},
"example": "Tue, 05 May 2020 09:26:03 GMT"
}
}
},
"x-frame-options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResetPassword-Invalidnewpassword1"
},
"example": {
"message": "minimum password length should be : 8"
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-auth-user:users/user=SampleUser": {
"put": {
"tags": [
"AAA Users"
],
"summary": "Assign User to User Group",
"description": "Assigns user to an existing user group, with the user name specified as a URL parameter.\n\n| Attribute | Description |\n| --- | --- |\n| group | **Required** A list of groups to assign to this user. |",
"operationId": "AssignUsertoUserGroup",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssignUsertoUserGroupRequest"
},
"example": {
"group": [
"users-admin"
]
}
}
},
"required": true
},
"responses": {
"204": {
"description": "No Content",
"headers": {
"access-control-allow-origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"content-length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "0"
},
"example": "0"
}
}
},
"date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 05 May 2020 09:44:57 GMT"
},
"example": "Tue, 05 May 2020 09:44:57 GMT"
}
}
},
"x-frame-options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {}
}
},
"deprecated": false
},
"get": {
"tags": [
"AAA Users"
],
"summary": "Get User",
"description": "A list of user associated permissions and other settings. Returns a list of attributes as a response. The user name is specified as a URL parameter.\n\n| Attribute | Description |\n| --- | --- |\n| username | The unique username of the user. |\n| account-status | The current status of the user account. Default value: active Possible values: active, locked, expired or deactivated |\n| password-expiration-date | The time at which user's account-password expires. Date Time Format: yyyy-MM-dd'T'HH:mm:ss.ff'Z' eg. `2020-05-02T22:30:00Z` |\n| last-login-time |Timestamp of the last login. Date Time Format: yyyy-MM-dd'T'HH:mm:ss.ff'Z' eg. `2020-05-02T22:30:00Z` |\n| failed-login-attempts | The number of times the user has failed to log in since the last successful login. Date Time Format: yyyy-MM-dd'T'HH:mm:ss.ff'Z' eg. `2020-05-02T22:30:00Z` |\n| password-expiry-days | Number of days after which user's password will expire. -1 indicates that password never expires. Default value: 90 Possible values: -1, 1..180 |\n| max-failed-logins | Maximum number of consecutive times an incorrect password is allowed to be entered before the user's account will be locked. A value of 0 means that an unlimited number of failed attempts are allowed. Default value: 5 Possible values 1...256 |\n| logged-in | The current logged-in status of the user. Default value: false Possible values: true or false |\n| password-notice-days | Number of days prior to password expiration when user will be notified that his password is going to expire. Default value: 5 Possible values: 1..30 |\n| account-lock-period | Amount of time (in minutes) for which user's account gets locked. Default value: 5 Possible values: 1...65535 |\n| authorization-mode | The mode for user-authorization in priority order. |\n| authentication-mode | The mode for user-authentication in priority order. |\n| group | A list of groups this user is assigned to. |\n| account-expiration-date | Time at which user's account expires. This value is an empty string, if this account will not expire. Date Time Format: yyyy-MM-dd'T'HH:mm:ss.ff'Z' eg. `2020-05-02T22:30:00Z` |\n| user-type | Indicates if user is logged in with internal or external policy. Possible values: internal or external |",
"operationId": "GetUser",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"enum": [
"application/json"
],
"type": "string",
"example": "application/json"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"access-control-allow-origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"content-length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "402"
},
"example": "402"
}
}
},
"content-type": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "application/json; charset=UTF-8"
},
"example": "application/json; charset=UTF-8"
}
}
},
"date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 05 May 2020 09:29:08 GMT"
},
"example": "Tue, 05 May 2020 09:29:08 GMT"
}
}
},
"x-frame-options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RetrieveUsername-Success"
},
"example": {
"user-type": "internal",
"last-login-time": "2020-05-05T09:25:19.807Z",
"username": "Test-Account",
"account-status": "active",
"password-expiration-date": "2020-08-03T09:25:19.850Z",
"failed-login-attempts": 0,
"password-expiry-days": 90,
"account-expiration-date": "",
"max-failed-logins": 5,
"logged-in": false,
"password-notice-days": 5,
"account-lock-period": 5,
"authorization-mode": [
"internal"
],
"authentication-mode": [
"internal"
],
"group": []
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"access-control-allow-origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"content-length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "0"
},
"example": "0"
}
}
},
"date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 05 May 2020 09:46:25 GMT"
},
"example": "Tue, 05 May 2020 09:46:25 GMT"
}
}
},
"x-frame-options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {}
}
},
"deprecated": false
},
"patch": {
"tags": [
"AAA Users"
],
"summary": "Modify User - AAA Modes",
"description": "This API is used to modify/update the authentication mode of the user whose name is passed in the query parameter of the URL.\n\n \nRequest query parameter details - \n \n\n| Attribute | Description |\n| --- | --- |\n| user | **Required** A unique username of the user. |\n\n \nRequest body details - \n \n\n| Attribute | Description |\n| --- | --- |\n| authentication-mode | The mode for user authentication in priority order. Possible values : internal, radius, tacacsplus Default value: internal|\n| authorization-mode | The mode for user authorization in priority order. Possible values : internal, radius, tacacsplus Default value: internal|\n| accounting-mode | The mode for user accounting in priority order. Possible values : internal, radius, tacacsplus Default value: internal|",
"operationId": "ModifyUser-AAAModes",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModifyUser-AAAModesRequest"
},
"example": {
"authentication-mode": [
"tacacsplus",
"internal"
],
"authorization-mode": [
"tacacsplus",
"internal"
],
"accounting-mode": [
"radius"
]
}
}
},
"required": true
},
"responses": {
"204": {
"description": "No Content",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 05 Jan 2021 17:17:31 GMT"
},
"example": "Tue, 05 Jan 2021 17:17:31 GMT"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
}
},
"content": {}
}
},
"deprecated": false
}
},
"/data/adtran-auth-user:users": {
"get": {
"tags": [
"AAA Users"
],
"summary": "Get All Users",
"description": "A list of created users and their associated permissions and other settings. Returns a list of attribute as a response.\n\n| Attribute | Description |\n| --- | --- |\n| username | The unique username of the user. |\n| account-status | The current status of the user account. Default value: active Possible values: active, locked, expired or deactivated |\n| password-expiration-date | The time at which user's account-password expires. Date Time Format: yyyy-MM-dd'T'HH:mm:ss.ff'Z' eg. `2020-05-02T22:30:00Z` |\n| last-login-time | Timestamp of the last login. Date Time Format: yyyy-MM-dd'T'HH:mm:ss.ff'Z' eg. `2020-05-02T22:30:00Z` |\n| failed-login-attempts | The number of times the user has failed to log in since the last successful login. Date Time Format: yyyy-MM-dd'T'HH:mm:ss.ff'Z' eg. `2020-05-02T22:30:00Z` |\n| password-expiry-days | Number of days after which user's password will expire. -1 indicates that password never expires. Default value: 90 Possible values: -1, 1..180 |\n| max-failed-logins | Maximum number of consecutive times an incorrect password is allowed to be entered before the user's account will be locked. A value of 0 means that an unlimited number of failed attempts are allowed. Default value: 5 Possible values 1...256 |\n| logged-in | The current logged-in status of the user. Default value: false Possible values: true or false |\n| password-notice-days | Number of days prior to password expiration when user will be notified that his password is going to expire. Default value: 5 Possible values: 1..30 |\n| account-lock-period | Amount of time (in minutes) for which user's account gets locked. Default value: 5 Possible values: 1...65535 |\n| authorization-mode | The mode for user-authorization in priority order. |\n| authentication-mode | The mode for user-authentication in priority order. |\n| group | A list of groups this user is assigned to. |\n| account-expiration-date | Time at which user's account expires. This value is an empty string, if this account will not expire. Date Time Format: yyyy-MM-dd'T'HH:mm:ss.ff'Z' eg. `2020-05-02T22:30:00Z` |",
"operationId": "GetAllUsers",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"enum": [
"application/json"
],
"type": "string",
"example": "application/json"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"access-control-allow-origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"content-length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "1195"
},
"example": "1195"
}
}
},
"content-type": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "application/json; charset=UTF-8"
},
"example": "application/json; charset=UTF-8"
}
}
},
"date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 05 May 2020 09:28:33 GMT"
},
"example": "Tue, 05 May 2020 09:28:33 GMT"
}
}
},
"x-frame-options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RetrieveAllUsers-Success"
},
"description": "",
"example": [
{
"user-type": "internal",
"last-login-time": "2020-05-05T09:27:31.035Z",
"username": "ADMIN",
"account-status": "active",
"password-expiration-date": "2020-07-31T10:20:49.115Z",
"failed-login-attempts": 0,
"password-expiry-days": 90,
"account-expiration-date": "",
"max-failed-logins": 5,
"logged-in": true,
"password-notice-days": 5,
"account-lock-period": 5,
"authorization-mode": [
"internal"
],
"authentication-mode": [
"internal"
],
"group": [
"super-user"
]
},
{
"user-type": "internal",
"last-login-time": "2020-05-05T09:25:19.807Z",
"username": "Test-Account",
"account-status": "active",
"password-expiration-date": "2020-08-03T09:25:19.850Z",
"failed-login-attempts": 0,
"password-expiry-days": 90,
"account-expiration-date": "",
"max-failed-logins": 5,
"logged-in": false,
"password-notice-days": 5,
"account-lock-period": 5,
"authorization-mode": [
"internal"
],
"authentication-mode": [
"internal"
],
"group": []
},
{
"user-type": "internal",
"last-login-time": "",
"username": "Test-User-Account",
"account-status": "active",
"password-expiration-date": "2020-05-04T09:21:16.018Z",
"failed-login-attempts": 0,
"password-expiry-days": 90,
"account-expiration-date": "",
"max-failed-logins": 5,
"logged-in": false,
"password-notice-days": 5,
"account-lock-period": 5,
"authorization-mode": [
"internal"
],
"authentication-mode": [
"internal"
],
"group": []
}
]
},
"example": [
{
"user-type": "internal",
"last-login-time": "2020-05-05T09:27:31.035Z",
"username": "ADMIN",
"account-status": "active",
"password-expiration-date": "2020-07-31T10:20:49.115Z",
"failed-login-attempts": 0,
"password-expiry-days": 90,
"account-expiration-date": "",
"max-failed-logins": 5,
"logged-in": true,
"password-notice-days": 5,
"account-lock-period": 5,
"authorization-mode": [
"internal"
],
"authentication-mode": [
"internal"
],
"group": [
"super-user"
]
},
{
"user-type": "internal",
"last-login-time": "2020-05-05T09:25:19.807Z",
"username": "Test-Account",
"account-status": "active",
"password-expiration-date": "2020-08-03T09:25:19.850Z",
"failed-login-attempts": 0,
"password-expiry-days": 90,
"account-expiration-date": "",
"max-failed-logins": 5,
"logged-in": false,
"password-notice-days": 5,
"account-lock-period": 5,
"authorization-mode": [
"internal"
],
"authentication-mode": [
"internal"
],
"group": []
},
{
"user-type": "internal",
"last-login-time": "",
"username": "Test-User-Account",
"account-status": "active",
"password-expiration-date": "2020-05-04T09:21:16.018Z",
"failed-login-attempts": 0,
"password-expiry-days": 90,
"account-expiration-date": "",
"max-failed-logins": 5,
"logged-in": false,
"password-notice-days": 5,
"account-lock-period": 5,
"authorization-mode": [
"internal"
],
"authentication-mode": [
"internal"
],
"group": []
}
]
}
}
}
},
"deprecated": false
}
},
"/operations/adtran-auth-user:set-password": {
"post": {
"tags": [
"AAA Users"
],
"summary": "Set Password",
"description": "Set a new password for the current user with the user name specified as a URL parameter.\n\n| Attribute | Description |\n| --- | --- |\n| password | **Required:** New password which will authenticate the user. |",
"operationId": "SetPassword",
"parameters": [
{
"name": "Username",
"in": "query",
"description": "",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "SampleUser"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SetPasswordRequest"
},
"example": {
"password": "P@ssw1rd"
}
}
},
"required": true
},
"responses": {
"400": {
"description": "Bad Request",
"headers": {
"access-control-allow-origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"content-length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "49"
},
"example": "49"
}
}
},
"content-type": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "application/json; charset=UTF-8"
},
"example": "application/json; charset=UTF-8"
}
}
},
"date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 05 May 2020 09:54:49 GMT"
},
"example": "Tue, 05 May 2020 09:54:49 GMT"
}
}
},
"x-frame-options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SetPassword-Invalidpasswordvalue1"
},
"example": {
"message": "That password may not be reused yet"
}
}
}
},
"200": {
"description": "OK",
"headers": {
"access-control-allow-origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"content-length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "0"
},
"example": "0"
}
}
},
"date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 05 May 2020 09:57:13 GMT"
},
"example": "Tue, 05 May 2020 09:57:13 GMT"
}
}
},
"x-frame-options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {}
}
},
"deprecated": false,
"security": [
{
"basic": []
}
]
}
},
"/operations/adtran-auth-user:logout-user": {
"post": {
"tags": [
"AAA Users"
],
"summary": "Logout User",
"description": "Administrator can force logout a particular user or all users from the system.\n\n----\n### Note\n* logout-all option is directly used in the request url without a body",
"operationId": "LogoutUser",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LogoutUserRequest"
},
"example": {
"username": "SampleUser"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 08 May 2020 12:06:36 GMT"
},
"example": "Fri, 08 May 2020 12:06:36 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "0"
},
"example": "0"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {}
},
"400": {
"description": "Bad Request",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 08 May 2020 12:07:40 GMT"
},
"example": "Fri, 08 May 2020 12:07:40 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "35"
},
"example": "35"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"type": "string",
"example": " USER Test-Account is not logged in"
},
"example": " USER Test-Account is not logged in"
}
}
}
},
"deprecated": false
}
},
"/operations/adtran-auth-user:expire-password": {
"post": {
"tags": [
"AAA Users"
],
"summary": "Expire Password",
"description": "Forcibly expire a user's password which will force the user to change their password. It can only be used by the ADMIN user.\n\n| Attribute | Description |\n| --- | --- |\n| username | **Required:** Unique username of the user. |",
"operationId": "ExpirePassword",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExpirePasswordRequest"
},
"example": {
"username": "SampleUser"
}
}
},
"required": true
},
"responses": {
"404": {
"description": "Not Found",
"headers": {
"access-control-allow-origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"content-length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "48"
},
"example": "48"
}
}
},
"content-type": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "application/json; charset=UTF-8"
},
"example": "application/json; charset=UTF-8"
}
}
},
"date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 05 May 2020 09:56:35 GMT"
},
"example": "Tue, 05 May 2020 09:56:35 GMT"
}
}
},
"x-frame-options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExpirePassword-InvalidUser1"
},
"example": {
"message": "User Test-Account1 does not exist."
}
}
}
},
"200": {
"description": "OK",
"headers": {
"access-control-allow-origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"content-length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "0"
},
"example": "0"
}
}
},
"date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 05 May 2020 09:55:54 GMT"
},
"example": "Tue, 05 May 2020 09:55:54 GMT"
}
}
},
"x-frame-options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {}
}
},
"deprecated": false
}
},
"/operations/adtran-auth-user:logout-all": {
"post": {
"tags": [
"AAA Users"
],
"summary": "Logout All Users",
"description": "Administrator can force logout a particular user or all users from the system.\n\n----\n### Note\n* logout-all option is directly used in the request url without a body",
"operationId": "LogoutAllUsers",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"enum": [
"application/json"
],
"type": "string",
"example": "application/json"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"access-control-allow-origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"content-length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "0"
},
"example": "0"
}
}
},
"date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 05 May 2020 10:04:42 GMT"
},
"example": "Tue, 05 May 2020 10:04:42 GMT"
}
}
},
"x-frame-options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {}
}
},
"deprecated": false
}
},
"/operations/adtran-auth-user:delete-user": {
"post": {
"tags": [
"AAA Users"
],
"summary": "Delete User",
"description": "Delete an existing user by supplying the name.\n\n| Attribute | Description |\n| --- | --- |\n| username | **Required:** Name of the user to be deleted. |",
"operationId": "DeleteUser",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteUserRequest"
},
"example": {
"username": "SampleUser"
}
}
},
"required": true
},
"responses": {
"404": {
"description": "Not Found",
"headers": {
"access-control-allow-origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"content-length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "53"
},
"example": "53"
}
}
},
"content-type": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "application/json; charset=UTF-8"
},
"example": "application/json; charset=UTF-8"
}
}
},
"date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 05 May 2020 09:57:54 GMT"
},
"example": "Tue, 05 May 2020 09:57:54 GMT"
}
}
},
"x-frame-options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Delete-InvalidUser1"
},
"example": {
"message": "User Test-User-Account1 does not exist."
}
}
}
},
"204": {
"description": "No Content",
"headers": {
"access-control-allow-origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"content-length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "0"
},
"example": "0"
}
}
},
"date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 05 May 2020 09:58:18 GMT"
},
"example": "Tue, 05 May 2020 09:58:18 GMT"
}
}
},
"x-frame-options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {}
}
},
"deprecated": false
}
},
"/data/adtran-auth-radius-attributes-mapping:radius-attributes/vsa-to-permission-group": {
"post": {
"tags": [
"AAA Users"
],
"summary": "Create Vendor Specific Attribute Mapping for Radius",
"description": "Perform vendor specific attribute mapping so that RADIUS authenticated users can be authorized to MCP permissions groups based on RADIUS VSAs.\n\n| Attribute | Description |\n| --- | --- |\n|vendor-id|The id of the vendor according to IANA, e.g. 664 for ADTRAN.|\n|vendor-type|The type of the vendor specific attribute, e.g. 2 for ADTRAN-MOSAIC-CP-USER-GROUP.|\n|vendor-value|The value of the vendor specific attribute to match and assign the group(s) below.|\n|group|List of permission group names in MCP that the RADIUS user will be given upon login.|\n\nConsult the RADIUS dictionary called dictionary.adtran for more information and options.",
"operationId": "CreateVendorSpecificAttributeMappingforRadius",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateVendorSpecificAttributeMappingforRadiusRequest"
},
"example": {
"vendor-id": 664,
"vendor-type": 2,
"vendor-value": "attribute-name-from-radius-server",
"group": [
"edit-device-user",
"edit-interface-user"
]
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"deprecated": false
},
"get": {
"tags": [
"AAA Users"
],
"summary": "Get Vendor Specific Attribute Mapping for Radius",
"description": "Get all vendor specific attribute mapping so that RADIUS authenticated users can be authorized to MCP permissions groups based on RADIUS VSAs.\n\n| Attribute | Description |\n| --- | --- |\n|vendor-id|The id of the vendor according to IANA, e.g. 664 for ADTRAN.|\n|vendor-type|The type of the vendor specific attribute, e.g. 2 for ADTRAN-MOSAIC-CP-USER-GROUP.|\n|vendor-value|The value of the vendor specific attribute to match and assign the group(s) below.|\n|group|List of permission group names in MCP that the RADIUS user will be given upon login.|\n\nConsult the RADIUS dictionary called dictionary.adtran for more information and options.",
"operationId": "GetVendorSpecificAttributeMappingforRadius",
"parameters": [],
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"deprecated": false
}
},
"/data/adtran-auth-radius-attributes-mapping:radius-attributes/vsa-to-permission-group=664,2,attribute-name-from-radius-server": {
"put": {
"tags": [
"AAA Users"
],
"summary": "Modify Vendor Specific Attribute Mapping for Radius",
"description": "Modify vendor specific attribute mapping so that RADIUS authenticated users can be authorized to MCP permissions groups based on RADIUS VSAs.\n\n \nRequest query parameter details - \n \n\n| Attribute | Description |\n| --- | --- |\n| vsa-to-permission-group | **Required** vendor-id,vendor-type,vendor-value |\n\n \nRequest body details - \n \n\n| Attribute | Description |\n| --- | --- |\n|vendor-id|The id of the vendor according to IANA, e.g. 664 for ADTRAN.|\n|vendor-type|The type of the vendor specific attribute, e.g. 2 for ADTRAN-MOSAIC-CP-USER-GROUP.|\n|vendor-value|The value of the vendor specific attribute to match and assign the group(s) below.|\n|group|List of permission group names in MCP that the RADIUS user will be given upon login.|\n\nConsult the RADIUS dictionary called dictionary.adtran for more information and options.",
"operationId": "ModifyVendorSpecificAttributeMappingforRadius",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModifyVendorSpecificAttributeMappingforRadiusRequest"
},
"example": {
"vendor-id": 664,
"vendor-type": 2,
"vendor-value": "attribute-name-from-radius-server",
"group": [
"super-user"
]
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"deprecated": false
},
"delete": {
"tags": [
"AAA Users"
],
"summary": "Delete Vendor Specific Attribute Mapping for Radius",
"description": "Delete vendor specific attribute mapping so that RADIUS authenticated users can be authorized to MCP permissions groups based on RADIUS VSAs.\n\n \nRequest query parameter details - \n \n\n| Attribute | Description |\n| --- | --- |\n| vsa-to-permission-group | **Required** vendor-id,vendor-type,vendor-value |",
"operationId": "DeleteVendorSpecificAttributeMappingforRadius",
"parameters": [],
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"deprecated": false
}
},
"/operations/adtran-auth-accounting:get-filtered-logs": {
"post": {
"tags": [
"Accounting Logs"
],
"summary": "Get Account Logs Between Dates and Time",
"description": "Get the Account logs between any duration.\n\n| Attributes | Description |\n| --- | --- |\n| from-time | Select logs that occured on or after the given time. If not present, no lower bound will be used on the time period. Date Time Format : yyyy-MM-dd'T'HH:mm:ss.ff'Z' eg. `2020-05-02T22:30:00Z`. |\n| to-time | Select logs that occured on or before the given time. If not present, no upper bound will be used on the time period. Date Time Format : yyyy-MM-dd'T'HH:mm:ss.ff'Z' eg. `2020-05-02T22:30:00Z`. |\n\n \nResponse Data Details - \n \n\n| Attribute | Description |\n| --- | --- |\n| method | HTTP method used for request by the user. Possible Values: get, post, put, patch or delete |\n| log-id | Unique ID of the accounting log entry. Possible Format: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12} |\n| username | Unique name of the user who sent the request. |\n| uri | URI requested by the user. |\n| status | Select logs in which the status-code string provided is a substring of the stored status-code. For example '20' would match '200 OK, 201 Created, 204 No Content'. |\n| req-time | Time at which the request was received. Date Time Format : yyyy-MM-dd'T'HH:mm:ss.ff'Z' eg. `2020-05-02T22:30:00Z`. |\n| content |\tContent or body of request by the user. |\n| ip-address |\tOrigin of the request in the accounting log entry. Possible Formats: ipv4-address or ipv6-address |\n\n\n----\n### Note\n* If from-time is not specified then no lower bound is used for date and time.\n* If to-time is not specified then the current date and time is used.",
"operationId": "GetAccountLogsBetweenDatesandTime",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetAccountLogsBetweenDatesandTimeRequest"
},
"example": {
"time-period": {
"from-time": "2020-01-02T00:00:00.000Z",
"to-time": "2020-04-02T12:00:00.000Z"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Wed, 06 May 2020 06:51:43 GMT"
},
"example": "Wed, 06 May 2020 06:51:43 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Vary": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
},
"example": "Accept-Encoding"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "gzip"
},
"example": "gzip"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/GetAccountLogsBetweenDates"
},
"example": {
"log-entry": [
{
"method": "POST",
"log-id": "e1165ef5-09be-4a34-ba5f-cebef7daa305",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-auth-accounting:get-filtered-logs",
"status-code": "200 OK",
"req-time": "2020-05-06T06:51:32+00:00",
"content": "{\r\n \"time-period\" : {\r\n \"from-time\" : \"2020-01-02T00:00:00.000Z\",\r\n \"to-time\" : \"2020-05-06T12:00:00.000Z\"\r\n }\r\n}\r\n",
"ip-address": "172.22.178.20"
},
{
"method": "POST",
"log-id": "0bd268b6-e43f-4ea9-b309-717a963c094a",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-auth-accounting:get-filtered-logs",
"status-code": "200 OK",
"req-time": "2020-05-06T06:50:58+00:00",
"content": "{\r\n \"time-period\" : {\r\n \"from-time\" : \"2020-01-02T00:00:00.000Z\",\r\n \"to-time\" : \"2020-04-02T12:00:00.000Z\"\r\n }\r\n}\r\n",
"ip-address": "172.22.178.20"
},
{
"method": "POST",
"log-id": "32d95ef9-b3bd-4080-b4cb-968be29aec17",
"username": "{\"message\":\"Failed authentication\"}",
"uri": "/restconf/operations/adtran-auth-accounting:get-filtered-logs",
"status-code": "401 Unauthorized",
"req-time": "2020-05-06T06:50:33+00:00",
"content": "{\r\n \"time-period\" : {\r\n \"from-time\" : \"2020-01-02T00:00:00.000Z\",\r\n \"to-time\" : \"2020-04-02T12:00:00.000Z\"\r\n }\r\n}\r\n",
"ip-address": "172.22.178.20"
},
{
"method": "POST",
"log-id": "e273be9d-a02f-4965-bd09-34587588b21d",
"username": "Username Not Provided",
"uri": "/restconf/operations/adtran-auth-token:request-token",
"status-code": "200 OK",
"req-time": "2020-05-06T06:50:26+00:00",
"content": "{\"password\":\"********\",\"username\":\"ADMIN\"}",
"ip-address": "172.22.178.20"
},
{
"method": "POST",
"log-id": "fa438e15-004c-414a-94d1-6050b4e80744",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:create",
"status-code": "409 Conflict",
"req-time": "2020-05-06T06:42:06+00:00",
"content": "{\r\n \"input\": {\r\n \"server-context\": {\r\n \"server-name\": \"Server\",\r\n \"type\": [\r\n \"TFTP\"\r\n ],\r\n \"credentials-name\": \"Credentials\"\r\n }\r\n }\r\n}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "9b6ad552-6659-4f83-817f-1d39e6c40b2e",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-event-workflow:get-events",
"status-code": "400 Bad Request",
"req-time": "2020-05-06T06:40:56+00:00",
"content": "{\r\n \"input\": {\r\n \"summary-field: \"severity\",\r\n \"current\": false,\r\n \"cursor\": 0,\r\n \"result-size\": 25,\r\n \"exact-match\": true\r\n }\r\n}",
"ip-address": "172.22.182.150"
},
{
"method": "POST",
"log-id": "979b7e5f-2f92-4d77-b84d-f0e0d797ead4",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-event-workflow:get-events",
"status-code": "200 OK",
"req-time": "2020-05-06T06:40:02+00:00",
"content": "{\r\n \"input\": {\r\n \"summary-field\": \"severity\",\r\n \"current\": false,\r\n \"cursor\": 0,\r\n \"result-size\": 25,\r\n \"exact-match\": true\r\n }\r\n}",
"ip-address": "172.22.182.150"
},
{
"method": "POST",
"log-id": "96a6082b-5a9b-4d35-ac84-fa323f69bfae",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-event-workflow:get-events",
"status-code": "400 Bad Request",
"req-time": "2020-05-06T06:39:18+00:00",
"content": "{\r\n \"input\": {\r\n \"summary-field\": \"severity\",\r\n \"current\": false,\r\n \"cursor\": 0,\r\n \"result-size\": 25,\r\n \"exact-match\": true,\r\n }\r\n}",
"ip-address": "172.22.182.150"
},
{
"method": "POST",
"log-id": "86549002-14be-4b62-b0ae-35a6560eca15",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-event-workflow:get-events",
"status-code": "400 Bad Request",
"req-time": "2020-05-06T06:38:51+00:00",
"content": "{\r\n \"input\": {\r\n \"summary-fie\": \"severity\",\r\n \"current\": false,\r\n \"cursor\": 0,\r\n \"result-size\": 25,\r\n \"exact-match\": true,\r\n }\r\n}",
"ip-address": "172.22.182.150"
},
{
"method": "POST",
"log-id": "e541a8a0-8125-4813-bff7-ea2b3b5d2a0a",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-event-workflow:get-events",
"status-code": "400 Bad Request",
"req-time": "2020-05-06T06:36:20+00:00",
"content": "{\r\n \"input\": {\r\n \"summary-field\": \"severity\",\r\n \"current\": false,\r\n \"cursor\": 0,\r\n \"result-size\": 25,\r\n \"exact-match\": true,\r\n \"search-filter-and\": [\r\n {\r\n \"search-field\": \"severity\",\r\n \"search-value\": [\r\n \"missing\"\r\n ]\r\n }\r\n ]\r\n }\r\n}",
"ip-address": "172.22.182.150"
},
{
"method": "POST",
"log-id": "7dd2fb86-0123-48ab-b60c-3cccdb0bd486",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-event-workflow:get-events",
"status-code": "400 Bad Request",
"req-time": "2020-05-06T06:36:02+00:00",
"content": "{\r\n \"input\": {\r\n \"summary-field\": \"severity\",\r\n \"current\": false,\r\n \"cursor\": 0,\r\n \"result-size\": 25,\r\n \"exact-match\": true,\r\n \"search-filter-and\": [\r\n {\r\n \"search-field\": \"severity\",\r\n \"search-value\": [\r\n \"maj\"\r\n ]\r\n }\r\n ]\r\n }\r\n}",
"ip-address": "172.22.182.150"
},
{
"method": "POST",
"log-id": "435f7201-fde3-4d67-ad0e-9c8a62bc3fa1",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-event-workflow:get-events",
"status-code": "200 OK",
"req-time": "2020-05-06T06:35:50+00:00",
"content": "{\r\n \"input\": {\r\n \"summary-field\": \"severity\",\r\n \"current\": false,\r\n \"cursor\": 0,\r\n \"result-size\": 25,\r\n \"exact-match\": true,\r\n \"search-filter-and\": [\r\n {\r\n \"search-field\": \"sever\",\r\n \"search-value\": [\r\n \"major\"\r\n ]\r\n }\r\n ]\r\n }\r\n}",
"ip-address": "172.22.182.150"
},
{
"method": "POST",
"log-id": "46d4a339-9b7c-4de9-8061-18039184be3b",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-event-workflow:get-events",
"status-code": "200 OK",
"req-time": "2020-05-06T06:35:19+00:00",
"content": "{\r\n \"input\": {\r\n \"summary-field\": \"severity\",\r\n \"current\": false,\r\n \"cursor\": 0,\r\n \"result-size\": 25,\r\n \"exact-match\": true,\r\n \"search-filter\": [\r\n {\r\n \"search-field\": \"severity\",\r\n \"search-value\": [\r\n \"major\"\r\n ]\r\n }\r\n ]\r\n }\r\n}",
"ip-address": "172.22.182.150"
},
{
"method": "POST",
"log-id": "314fec6f-5d3d-456d-93ae-c1d145b8db74",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-event-workflow:get-events",
"status-code": "200 OK",
"req-time": "2020-05-06T06:35:03+00:00",
"content": "{\r\n \"input\": {\r\n \"summary-field\": \"severity\",\r\n \"current\": false,\r\n \"cursor\": 0,\r\n \"result-size\": 25,\r\n \"exact-match\": true,\r\n \"search-filter-and\": [\r\n {\r\n \"search-field\": \"severity\",\r\n \"search-value\": [\r\n \"major\"\r\n ]\r\n }\r\n ]\r\n }\r\n}",
"ip-address": "172.22.182.150"
},
{
"method": "POST",
"log-id": "c543f9c4-2f2b-4b96-aebb-92e8c66a40eb",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-event-workflow:get-events",
"status-code": "200 OK",
"req-time": "2020-05-06T06:34:52+00:00",
"content": "{\r\n \"input\": {\r\n \"summary-field\": \"severity\",\r\n \"current\": false,\r\n \"cursor\": 0,\r\n \"result-size\": 25,\r\n \"exact-match\": true,\r\n \"search-filter-and\": [\r\n {\r\n \"search-field\": \"severity\",\r\n \"search-value\": [\r\n \"minor\"\r\n ]\r\n }\r\n ]\r\n }\r\n}",
"ip-address": "172.22.182.150"
},
{
"method": "POST",
"log-id": "1d588c06-5eb8-4142-99fb-0b5d4c04dd42",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-event-workflow:get-events",
"status-code": "400 Bad Request",
"req-time": "2020-05-06T06:34:37+00:00",
"content": "{\r\n \"input\": {\r\n \"summary-field\": \"severity\",\r\n \"current\": true,\r\n \"curs\": 0,\r\n \"result-size\": 25,\r\n \"exact-match\": true,\r\n \"search-filter-and\": [\r\n {\r\n \"search-field\": \"severity\",\r\n \"search-value\": [\r\n \"minor\"\r\n ]\r\n }\r\n ]\r\n }\r\n}",
"ip-address": "172.22.182.150"
},
{
"method": "POST",
"log-id": "03cd9a62-7b08-485f-acad-138334c52a24",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-event-workflow:get-events",
"status-code": "200 OK",
"req-time": "2020-05-06T06:34:19+00:00",
"content": "{\r\n \"input\": {\r\n \"summary-field\": \"severity\",\r\n \"current\": true,\r\n \"cursor\": 0,\r\n \"result-size\": 344555555555,\r\n \"exact-match\": true,\r\n \"search-filter-and\": [\r\n {\r\n \"search-field\": \"severity\",\r\n \"search-value\": [\r\n \"minor\"\r\n ]\r\n }\r\n ]\r\n }\r\n}",
"ip-address": "172.22.182.150"
},
{
"method": "POST",
"log-id": "e7b6464e-c004-4941-bb6e-504ae99f0287",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-event-workflow:get-events",
"status-code": "200 OK",
"req-time": "2020-05-06T06:34:06+00:00",
"content": "{\r\n \"input\": {\r\n \"summary-field\": \"severity\",\r\n \"current\": true,\r\n \"cursor\": 0,\r\n \"result-size\": -1,\r\n \"exact-match\": true,\r\n \"search-filter-and\": [\r\n {\r\n \"search-field\": \"severity\",\r\n \"search-value\": [\r\n \"minor\"\r\n ]\r\n }\r\n ]\r\n }\r\n}",
"ip-address": "172.22.182.150"
},
{
"method": "GET",
"log-id": "370c8fb7-6a4f-4561-b742-421b1a229503",
"username": "ADMIN",
"uri": "/restconf/data/adtran-cloud-platform-uiworkflow:transitions/transition=3b2c4ba3-9022-4700-8142-16553c2cbf70",
"status-code": "200 OK",
"req-time": "2020-05-06T06:33:57+00:00",
"content": "",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "0aaa05bd-d806-482b-b991-0ac2420c6998",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:delete",
"status-code": "200 OK",
"req-time": "2020-05-06T06:33:56+00:00",
"content": "{\"input\":{\"server-context\":{\"server-name\":\"1\"}}}",
"ip-address": "172.22.181.204"
},
{
"method": "GET",
"log-id": "541d8ecc-ec8c-4f55-bc34-f4ee15a8a535",
"username": "ADMIN",
"uri": "/restconf/data/adtran-cloud-platform-uiworkflow:transitions/transition=af5c3331-c339-4985-89f4-7caebbc8d19b",
"status-code": "200 OK",
"req-time": "2020-05-06T06:33:52+00:00",
"content": "",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "f50e22fa-ea34-41df-9e7c-36a2570a69be",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:undeploy",
"status-code": "200 OK",
"req-time": "2020-05-06T06:33:51+00:00",
"content": "{\"input\":{\"server-context\":{\"server-name\":\"1\"}}}",
"ip-address": "172.22.181.204"
},
{
"method": "GET",
"log-id": "fe0c1d80-49f0-49ad-97d8-7d6318f7d467",
"username": "ADMIN",
"uri": "/restconf/data/adtran-cloud-platform-uiworkflow:transitions/transition=94fe85fb-128a-4806-b0f6-322af1eead3b",
"status-code": "200 OK",
"req-time": "2020-05-06T06:33:12+00:00",
"content": "",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "b874fdd7-90d9-4d85-8c9f-555bd46aef5a",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:deploy",
"status-code": "200 OK",
"req-time": "2020-05-06T06:33:11+00:00",
"content": "{\"input\":{\"server-context\":{\"server-name\":\"1\",\"host-ip\":\"1.1.1.1\",\"port\":\"1\",\"data-center-name\":\"Data Center\"}}}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "9c3208b1-62be-48a4-834c-01079af32b09",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-search:search",
"status-code": "200 OK",
"req-time": "2020-05-06T06:33:10+00:00",
"content": "{\"input\":{\"type\":\"search-global\",\"related-objects-term\":{\"cursor\":0,\"result-size\":25,\"search-term\":\"Data Center\",\"object-type\":\"data-center\",\"search-field\":\"data-center-name\",\"extra-search-fields\":[]}}}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "c813398d-a940-468a-90cb-f790afe56d0b",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-search:search",
"status-code": "200 OK",
"req-time": "2020-05-06T06:32:58+00:00",
"content": "{\"input\":{\"type\":\"search-global\",\"related-objects-term\":{\"cursor\":0,\"result-size\":25,\"search-term\":\"\",\"object-type\":\"data-center\",\"search-field\":\"data-center-name\",\"extra-search-fields\":[]}}}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "63d5425b-cfec-48d4-be27-18b70b34d369",
"username": "ADMIN",
"uri": "/restconf/data-filter/adtran-cloud-platform-uiworkflow-credentials:credentials/credential",
"status-code": "200 OK",
"req-time": "2020-05-06T06:32:56+00:00",
"content": "{\"credentials#like\":{\"field\":\"name\",\"keyword\":\"\",\"threshold\":0.1,\"target\":\"score\"}}",
"ip-address": "172.22.181.204"
},
{
"method": "GET",
"log-id": "3676192f-16c1-4ffc-a76d-b8889dcce06b",
"username": "ADMIN",
"uri": "/restconf/data/adtran-cloud-platform-uiworkflow-servers:servers/available-type",
"status-code": "200 OK",
"req-time": "2020-05-06T06:32:56+00:00",
"content": "",
"ip-address": "172.22.181.204"
},
{
"method": "GET",
"log-id": "95e87c9b-8d3a-4438-b71f-f12ce782b5ee",
"username": "ADMIN",
"uri": "/restconf/data/adtran-cloud-platform-uiworkflow-servers:servers/server=1",
"status-code": "200 OK",
"req-time": "2020-05-06T06:32:55+00:00",
"content": "",
"ip-address": "172.22.181.204"
},
{
"method": "GET",
"log-id": "f9fa9394-306a-4f89-a4a6-b2da9d2bf8b7",
"username": "ADMIN",
"uri": "/restconf/data/adtran-cloud-platform-servers:servers/server=1",
"status-code": "200 OK",
"req-time": "2020-05-06T06:32:55+00:00",
"content": "",
"ip-address": "172.22.181.204"
},
{
"method": "GET",
"log-id": "1256964d-a868-443c-a62d-2ba8dac26919",
"username": "ADMIN",
"uri": "/restconf/data/adtran-cloud-platform-uiworkflow:transitions/transition=5f705111-f3b8-4104-9eec-7a8490853984",
"status-code": "200 OK",
"req-time": "2020-05-06T06:32:54+00:00",
"content": "",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "8d11ae3f-8c1e-4ea0-9158-2b7021a0363d",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:create",
"status-code": "200 OK",
"req-time": "2020-05-06T06:32:52+00:00",
"content": "{\"input\":{\"server-context\":{\"server-name\":\"1\",\"type\":[\"TFTP\"]}}}",
"ip-address": "172.22.181.204"
},
{
"method": "GET",
"log-id": "82aa24ec-5426-4c0c-b41a-588514e2e6e2",
"username": "ADMIN",
"uri": "/restconf/data/adtran-cloud-platform-uiworkflow-servers:servers/available-type",
"status-code": "200 OK",
"req-time": "2020-05-06T06:32:47+00:00",
"content": "",
"ip-address": "172.22.181.204"
},
{
"method": "GET",
"log-id": "2013ae9f-6dd6-427d-8cad-1809d3fdf7b9",
"username": "ADMIN",
"uri": "/restconf/data/adtran-cloud-platform-uiworkflow-servers:servers/available-type",
"status-code": "200 OK",
"req-time": "2020-05-06T06:32:47+00:00",
"content": "",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "0b0eebe4-6230-4e32-aee8-afe93fd082b7",
"username": "ADMIN",
"uri": "/restconf/data-filter/adtran-cloud-platform-uiworkflow-credentials:credentials/credential",
"status-code": "200 OK",
"req-time": "2020-05-06T06:32:45+00:00",
"content": "{\"credentials#like\":{\"field\":\"name\",\"keyword\":\"\",\"threshold\":0.1,\"target\":\"score\"}}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "332b3bcc-726e-4d55-9a13-e717cf38624f",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-search:search",
"status-code": "200 OK",
"req-time": "2020-05-06T06:32:44+00:00",
"content": "{\"input\":{\"type\":\"search-global\",\"related-objects-term\":{\"cursor\":0,\"result-size\":25,\"search-term\":\"\",\"object-type\":\"data-center\",\"search-field\":\"data-center-name\",\"extra-search-fields\":[]}}}",
"ip-address": "172.22.181.204"
},
{
"method": "GET",
"log-id": "3be31646-afc4-47a4-a02e-ac9eadb8f8bb",
"username": "ADMIN",
"uri": "/restconf/data/adtran-cloud-platform-uiworkflow-force-actions:force-actions/force-action=server",
"status-code": "200 OK",
"req-time": "2020-05-06T06:32:43+00:00",
"content": "",
"ip-address": "172.22.181.204"
},
{
"method": "GET",
"log-id": "7b794def-b098-465f-88bd-10882e168a68",
"username": "ADMIN",
"uri": "/restconf/data/adtran-cloud-platform-uiworkflow-servers:servers/available-type",
"status-code": "200 OK",
"req-time": "2020-05-06T06:32:43+00:00",
"content": "",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "7e350675-e785-420b-850e-4c8c0b25e4f4",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-search:search",
"status-code": "200 OK",
"req-time": "2020-05-06T06:32:10+00:00",
"content": "{\"input\":{\"type\":\"search-global\",\"related-objects-term\":{\"cursor\":0,\"result-size\":25,\"search-term\":\"\",\"object-type\":\"data-center\",\"search-field\":\"\",\"extra-search-fields\":[]}}}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "a62ee6cd-7771-4572-b6c5-92d3de80afba",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-search:search",
"status-code": "200 OK",
"req-time": "2020-05-06T06:32:10+00:00",
"content": "{\"input\":{\"type\":\"search-global\",\"related-objects-term\":{\"cursor\":0,\"result-size\":25,\"search-term\":\"\",\"object-type\":\"data-center\",\"search-field\":\"\",\"extra-search-fields\":[]}}}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "af0048a1-cccf-4dcb-a783-e50a2d65f1ca",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-search:search",
"status-code": "200 OK",
"req-time": "2020-05-06T06:32:08+00:00",
"content": "{\"input\":{\"type\":\"search-global\",\"related-objects-term\":{\"cursor\":0,\"result-size\":25,\"search-term\":\"\",\"object-type\":\"server\",\"search-field\":\"\",\"extra-search-fields\":[]}}}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "eced01fc-8a83-4186-976b-193da6fada22",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-search:search",
"status-code": "200 OK",
"req-time": "2020-05-06T06:32:08+00:00",
"content": "{\"input\":{\"type\":\"search-global\",\"related-objects-term\":{\"cursor\":0,\"result-size\":25,\"search-term\":\"\",\"object-type\":\"server\",\"search-field\":\"\",\"extra-search-fields\":[]}}}",
"ip-address": "172.22.181.204"
},
{
"method": "GET",
"log-id": "ab80f8ba-0fd9-4c31-b71e-5d403c546562",
"username": "ADMIN",
"uri": "/restconf/data/adtran-cloud-platform-uiworkflow-force-actions:force-actions/force-action=server",
"status-code": "200 OK",
"req-time": "2020-05-06T06:31:58+00:00",
"content": "",
"ip-address": "172.22.181.204"
},
{
"method": "GET",
"log-id": "cd15cec1-4b1e-4096-8fdc-4bec6cd3e404",
"username": "ADMIN",
"uri": "/restconf/data/adtran-cloud-platform-uiworkflow-servers:servers/available-type",
"status-code": "200 OK",
"req-time": "2020-05-06T06:31:58+00:00",
"content": "",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "3c2ff2a2-8efe-4478-bca6-5dae0783c700",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-search:search",
"status-code": "200 OK",
"req-time": "2020-05-06T06:31:58+00:00",
"content": "{\"input\":{\"type\":\"search-global\",\"related-objects-term\":{\"cursor\":0,\"result-size\":25,\"search-term\":\"\",\"object-type\":\"data-center\",\"search-field\":\"data-center-name\",\"extra-search-fields\":[]}}}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "79c6b3a6-4fca-4fe9-a146-47873f95709e",
"username": "ADMIN",
"uri": "/restconf/data-filter/adtran-cloud-platform-uiworkflow-credentials:credentials/credential",
"status-code": "200 OK",
"req-time": "2020-05-06T06:31:58+00:00",
"content": "{\"credentials#like\":{\"field\":\"name\",\"keyword\":\"\",\"threshold\":0.1,\"target\":\"score\"}}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "a90deb60-e82c-4a48-bda1-b536d6e45232",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-search:search",
"status-code": "200 OK",
"req-time": "2020-05-06T06:31:50+00:00",
"content": "{\"input\":{\"type\":\"search-global\",\"related-objects-term\":{\"cursor\":0,\"result-size\":25,\"search-term\":\"\",\"object-type\":\"server\",\"search-field\":\"\",\"extra-search-fields\":[]}}}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "1615b12a-e44e-46fd-b55d-4babc036564c",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-search:search",
"status-code": "200 OK",
"req-time": "2020-05-06T06:31:48+00:00",
"content": "{\"input\":{\"type\":\"search-global\",\"related-objects-term\":{\"cursor\":0,\"result-size\":25,\"search-term\":\"\",\"object-type\":\"server\",\"search-field\":\"\",\"extra-search-fields\":[]}}}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "8a1a8230-775b-4623-88c4-04cea89d6b5c",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-search:search",
"status-code": "200 OK",
"req-time": "2020-05-06T06:31:48+00:00",
"content": "{\"input\":{\"type\":\"search-global\",\"related-objects-term\":{\"cursor\":0,\"result-size\":25,\"search-term\":\"\",\"object-type\":\"server\",\"search-field\":\"\",\"extra-search-fields\":[]}}}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "c77bc5ad-b7cd-44fb-9af4-355d263dc903",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-event-workflow:get-events",
"status-code": "400 Bad Request",
"req-time": "2020-05-06T06:31:44+00:00",
"content": "{\r\n \"input\": {\r\n \"current\": true,\r\n \"cursor\": 0,\r\n \"result-size\": 25,\r\n \"exact-match\": true,\r\n \"search-filter-and\": [\r\n {\r\n \"search-value\": [\r\n \"minor\"\r\n ]\r\n }\r\n ]\r\n }\r\n}",
"ip-address": "172.22.182.150"
},
{
"method": "POST",
"log-id": "ce7aacc0-56c3-4458-b30d-38a365572a22",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-event-workflow:get-events",
"status-code": "200 OK",
"req-time": "2020-05-06T06:31:34+00:00",
"content": "{\"input\":{\"summary-field\":\"severity\",\"current\":true,\"cursor\":0,\"result-size\":25,\"exact-match\":true}}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "8831f2b0-19e6-47fa-886f-6473752b7421",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-event-workflow:get-events",
"status-code": "200 OK",
"req-time": "2020-05-06T06:31:34+00:00",
"content": "{\"input\":{\"summary-field\":\"severity\",\"current\":true,\"cursor\":0,\"result-size\":25,\"exact-match\":true}}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "c233e190-ad5e-42e3-a92f-6d1dd3c46051",
"username": "Username Not Provided",
"uri": "/restconf/operations/adtran-auth-token:request-token",
"status-code": "200 OK",
"req-time": "2020-05-06T06:31:32+00:00",
"content": "{\"password\":\"********\",\"username\":\"ADMIN\"}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "4ca5ff05-f5f1-4fbf-a01c-68d332d01fe1",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-event-workflow:get-events",
"status-code": "200 OK",
"req-time": "2020-05-06T06:31:32+00:00",
"content": "{\"input\":{\"summary-field\":\"severity\",\"current\":true,\"cursor\":0,\"result-size\":25,\"exact-match\":true}}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "6e11e228-538e-46de-a058-240bf1f71dc6",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-event-workflow:get-event-summary",
"status-code": "200 OK",
"req-time": "2020-05-06T06:31:32+00:00",
"content": "{\"input\":{\"summary-field\":\"severity\",\"exact-match\":true}}",
"ip-address": "172.22.181.204"
},
{
"method": "GET",
"log-id": "db6a5810-8d03-43c6-9135-2953e75390f1",
"username": "Username Not Provided",
"uri": "/restconf/data/adtran-launchpad-login:login-screen",
"status-code": "200 OK",
"req-time": "2020-05-06T06:31:31+00:00",
"content": "",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "bb72f0ea-8bb5-4b88-9943-5a393af31149",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-event-workflow:get-events",
"status-code": "400 Bad Request",
"req-time": "2020-05-06T06:24:38+00:00",
"content": "{\r\n \"input\": {\r\n \"current\": true,\r\n \"cursor\": 0,\r\n \"result-size\": 25,\r\n \"exact-match\": true,\r\n \"search-filter-and\": [\r\n {\r\n \"search-value\": [\r\n \"minor\"\r\n ]\r\n }\r\n ]\r\n }\r\n}",
"ip-address": "172.22.182.150"
},
{
"method": "POST",
"log-id": "845c0db4-2ef5-4a8b-9658-1b893db6c0a7",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-event-workflow:get-events",
"status-code": "200 OK",
"req-time": "2020-05-06T06:24:24+00:00",
"content": "{\r\n \"input\": {\r\n \"current\": true,\r\n \"cursor\": 0,\r\n \"result-size\": 25,\r\n \"exact-match\": true,\r\n \"search-filter-and\": [\r\n {\r\n \"search-field\": \"severity\",\r\n \"search-value\": [\r\n \"minor\"\r\n ]\r\n }\r\n ]\r\n }\r\n}",
"ip-address": "172.22.182.150"
},
{
"method": "POST",
"log-id": "c0c08e31-3130-4b47-8fcb-2f2d38f42368",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow-jobs:get-job-context",
"status-code": "200 OK",
"req-time": "2020-05-06T06:23:33+00:00",
"content": "{\"input\":{\"action-name\":\"Download\"}}",
"ip-address": "172.22.179.175"
},
{
"method": "POST",
"log-id": "6babd527-6ccc-45d5-b6de-6f29812a2d15",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-search:search",
"status-code": "200 OK",
"req-time": "2020-05-06T06:23:33+00:00",
"content": "{\"input\":{\"type\":\"search-global\",\"related-objects-term\":{\"cursor\":0,\"result-size\":25,\"search-term\":\"\",\"object-type\":\"server\",\"search-field\":\"name\",\"extra-search-fields\":[{\"field\":\"state\",\"value-list\":[\"deployed\",\"activated\"]}]}}}",
"ip-address": "172.22.179.175"
},
{
"method": "POST",
"log-id": "f3aa7b11-306b-4977-ab4b-448587ed0c5c",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-search:search",
"status-code": "200 OK",
"req-time": "2020-05-06T06:23:33+00:00",
"content": "{\"input\":{\"type\":\"search-global\",\"related-objects-term\":{\"cursor\":0,\"result-size\":100,\"search-term\":\"\",\"object-type\":\"profile\",\"search-field\":\"name\",\"extra-search-fields\":[{\"field\":\"state\",\"value-list\":[\"deployed\",\"activated\"]},{\"field\":\"type\",\"value-list\":[\"device-software-profile\"]}]}}}",
"ip-address": "172.22.179.175"
},
{
"method": "GET",
"log-id": "400b134f-ae44-4fcc-ba57-dbd6797c2a4b",
"username": "ADMIN",
"uri": "/restconf/data/adtran-cloud-platform-uiworkflow-jobs:triggers",
"status-code": "200 OK",
"req-time": "2020-05-06T06:23:16+00:00",
"content": "",
"ip-address": "172.22.179.175"
},
{
"method": "POST",
"log-id": "272087aa-1439-48cf-80d5-13daf2f3034f",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow-jobs:get-job-context",
"status-code": "200 OK",
"req-time": "2020-05-06T06:23:15+00:00",
"content": "{\"input\":{\"action-name\":null}}",
"ip-address": "172.22.179.175"
},
{
"method": "GET",
"log-id": "c9418972-cef5-45c3-a835-ed85dcc808f6",
"username": "ADMIN",
"uri": "/restconf/data/adtran-cloud-platform-uiworkflow-jobs:actions",
"status-code": "200 OK",
"req-time": "2020-05-06T06:23:15+00:00",
"content": "",
"ip-address": "172.22.179.175"
},
{
"method": "POST",
"log-id": "3ab7e1fb-2eb9-4a39-bdbb-8828df83f7bf",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-search:search",
"status-code": "200 OK",
"req-time": "2020-05-06T06:23:10+00:00",
"content": "{\"input\":{\"type\":\"search-global\",\"related-objects-term\":{\"cursor\":0,\"result-size\":25,\"search-term\":\"\",\"object-type\":\"device\",\"search-field\":\"\",\"extra-search-fields\":[]}}}",
"ip-address": "172.22.179.175"
},
{
"method": "POST",
"log-id": "ec359d45-cf41-486a-920a-56d4e0bf5e13",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-search:search",
"status-code": "200 OK",
"req-time": "2020-05-06T06:23:09+00:00",
"content": "{\"input\":{\"type\":\"search-global\",\"related-objects-term\":{\"cursor\":0,\"result-size\":25,\"search-term\":\"\",\"object-type\":\"device\",\"search-field\":\"\",\"extra-search-fields\":[]}}}",
"ip-address": "172.22.179.175"
},
{
"method": "POST",
"log-id": "fb4f57e1-143b-4704-8051-56f334f64cb6",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-search:search",
"status-code": "200 OK",
"req-time": "2020-05-06T06:23:09+00:00",
"content": "{\"input\":{\"type\":\"search-global\",\"related-objects-term\":{\"cursor\":0,\"result-size\":25,\"search-term\":\"\",\"object-type\":\"device\",\"search-field\":\"\",\"extra-search-fields\":[]}}}",
"ip-address": "172.22.179.175"
},
{
"method": "POST",
"log-id": "05f5725d-2ec3-49d0-8f2f-35cb72963c5a",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow-jobs:get-job-context",
"status-code": "200 OK",
"req-time": "2020-05-06T06:22:32+00:00",
"content": "{\"input\":{\"action-name\":\"Reflow Device\"}}",
"ip-address": "172.22.179.175"
},
{
"method": "POST",
"log-id": "0e5efd6a-8985-400d-97ae-9b0729f23ffd",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow-jobs:get-job-context",
"status-code": "200 OK",
"req-time": "2020-05-06T06:22:25+00:00",
"content": "{\"input\":{\"action-name\":null}}",
"ip-address": "172.22.179.175"
},
{
"method": "POST",
"log-id": "25387e48-703e-4a1f-96b8-7f6ff0f73796",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-search:search",
"status-code": "200 OK",
"req-time": "2020-05-06T06:22:21+00:00",
"content": "{\"input\":{\"type\":\"search-global\",\"related-objects-term\":{\"cursor\":0,\"result-size\":100,\"search-term\":\"\",\"object-type\":\"service\",\"search-field\":\"service-id\",\"extra-search-fields\":[{\"field\":\"state\",\"value-list\":[\"deployed\",\"activated\"]}]}}}",
"ip-address": "172.22.179.175"
},
{
"method": "POST",
"log-id": "503a23bd-00e3-4216-b13f-0073953796dd",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-event-workflow:get-events",
"status-code": "400 Bad Request",
"req-time": "2020-05-06T06:22:21+00:00",
"content": "{\r\n \"input\": {\r\n \"summary-fie\": \"severity\",\r\n \"current\": true,\r\n \"cursor\": 0,\r\n \"result-size\": 25,\r\n \"exact-match\": true,\r\n \"search-filter-and\": [\r\n {\r\n \"search-fie\": \"severity\",\r\n \"search-value\": [\r\n \"minor\"\r\n ]\r\n }\r\n ]\r\n }\r\n}",
"ip-address": "172.22.182.150"
},
{
"method": "POST",
"log-id": "2e0c1ee4-4301-4492-8017-4fcd6850f1b9",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow-jobs:get-job-context",
"status-code": "200 OK",
"req-time": "2020-05-06T06:22:07+00:00",
"content": "{\"input\":{\"action-name\":\"Reflow Service\"}}",
"ip-address": "172.22.179.175"
},
{
"method": "POST",
"log-id": "c97a4be7-1540-4b9e-a0c7-0079b71d71df",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-event-workflow:get-events",
"status-code": "400 Bad Request",
"req-time": "2020-05-06T06:21:53+00:00",
"content": "{\r\n \"input\": {\r\n \"summary-fie\": \"state\",\r\n \"current\": true,\r\n \"cursor\": 0,\r\n \"result-size\": 25,\r\n \"exact-match\": true,\r\n \"search-filter-and\": [\r\n {\r\n \"search-fie\": \"state\",\r\n \"search-value\": [\r\n \"minor\"\r\n ]\r\n }\r\n ]\r\n }\r\n}",
"ip-address": "172.22.182.150"
},
{
"method": "GET",
"log-id": "1d95ca48-35a4-4626-970b-1c7de6732859",
"username": "ADMIN",
"uri": "/restconf/data/adtran-cloud-platform-uiworkflow-jobs:triggers",
"status-code": "200 OK",
"req-time": "2020-05-06T06:21:34+00:00",
"content": "",
"ip-address": "172.22.179.175"
},
{
"method": "GET",
"log-id": "2e0d5d21-8a02-4f0b-b33d-cd82171a157c",
"username": "ADMIN",
"uri": "/restconf/data/adtran-cloud-platform-uiworkflow-jobs:actions",
"status-code": "200 OK",
"req-time": "2020-05-06T06:21:34+00:00",
"content": "",
"ip-address": "172.22.179.175"
},
{
"method": "POST",
"log-id": "beacb433-6d17-471f-93c3-f89464221800",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow-jobs:get-job-context",
"status-code": "200 OK",
"req-time": "2020-05-06T06:21:32+00:00",
"content": "{\"input\":{\"action-name\":null}}",
"ip-address": "172.22.179.175"
},
{
"method": "POST",
"log-id": "0939768f-29d1-4aef-9d11-2f01ac00a78c",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-event-workflow:get-events",
"status-code": "200 OK",
"req-time": "2020-05-06T06:21:17+00:00",
"content": "{\"input\":{\"summary-field\":\"severity\",\"current\":true,\"cursor\":0,\"result-size\":25,\"exact-match\":true}}",
"ip-address": "172.22.179.175"
},
{
"method": "POST",
"log-id": "7fa72be7-4926-49a0-a41d-ccc83a396138",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-event-workflow:get-events",
"status-code": "200 OK",
"req-time": "2020-05-06T06:21:17+00:00",
"content": "{\"input\":{\"summary-field\":\"severity\",\"current\":true,\"cursor\":0,\"result-size\":25,\"exact-match\":true}}",
"ip-address": "172.22.179.175"
},
{
"method": "POST",
"log-id": "9380cb84-153b-48b2-a3a7-bd3e3c21da5b",
"username": "Username Not Provided",
"uri": "/restconf/operations/adtran-auth-token:request-token",
"status-code": "200 OK",
"req-time": "2020-05-06T06:21:16+00:00",
"content": "{\"password\":\"********\",\"username\":\"ADMIN\"}",
"ip-address": "172.22.179.175"
},
{
"method": "POST",
"log-id": "9bc58034-e0bb-4e00-9205-cb63aff8fc78",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-event-workflow:get-event-summary",
"status-code": "200 OK",
"req-time": "2020-05-06T06:21:16+00:00",
"content": "{\"input\":{\"summary-field\":\"severity\",\"exact-match\":true}}",
"ip-address": "172.22.179.175"
},
{
"method": "POST",
"log-id": "cb06c00b-f75d-4f1b-87f7-d7b6abd7083e",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-event-workflow:get-events",
"status-code": "200 OK",
"req-time": "2020-05-06T06:21:16+00:00",
"content": "{\"input\":{\"summary-field\":\"severity\",\"current\":true,\"cursor\":0,\"result-size\":25,\"exact-match\":true}}",
"ip-address": "172.22.179.175"
},
{
"method": "GET",
"log-id": "1ed83d1d-058e-48b9-a968-816b8f93e26a",
"username": "Username Not Provided",
"uri": "/restconf/data/adtran-launchpad-login:login-screen",
"status-code": "200 OK",
"req-time": "2020-05-06T06:21:15+00:00",
"content": "",
"ip-address": "172.22.179.175"
},
{
"method": "GET",
"log-id": "0a31b1ef-76f5-4deb-bb43-5d85c8c2420c",
"username": "Username Not Provided",
"uri": "/restconf/data/adtran-launchpad-login:login-screen",
"status-code": "200 OK",
"req-time": "2020-05-06T06:21:02+00:00",
"content": "",
"ip-address": "172.22.179.175"
},
{
"method": "GET",
"log-id": "28fa51e9-cce9-47e1-8ba5-cf1c8f229adf",
"username": "Username Not Provided",
"uri": "/restconf/data/adtran-launchpad-login:login-screen",
"status-code": "200 OK",
"req-time": "2020-05-06T06:20:59+00:00",
"content": "",
"ip-address": "172.22.179.175"
},
{
"method": "GET",
"log-id": "e992cec0-412e-40ca-891b-11ea8d5e2ae7",
"username": "Username Not Provided",
"uri": "/restconf/data/adtran-feature-flags:feature-flags",
"status-code": "200 OK",
"req-time": "2020-05-06T06:20:57+00:00",
"content": "",
"ip-address": "172.22.179.175"
},
{
"method": "GET",
"log-id": "e8b2cf43-ed0a-46ff-838e-459fd099ccc3",
"username": "Username Not Provided",
"uri": "/restconf/data/adtran-launchpad-login:login-screen",
"status-code": "200 OK",
"req-time": "2020-05-06T06:20:37+00:00",
"content": "",
"ip-address": "172.22.182.150"
},
{
"method": "GET",
"log-id": "9a93fc6a-9584-4379-9c0a-d27aa932c292",
"username": "Username Not Provided",
"uri": "/restconf/data/adtran-launchpad-login:login-screen",
"status-code": "200 OK",
"req-time": "2020-05-06T06:20:35+00:00",
"content": "",
"ip-address": "172.22.182.150"
},
{
"method": "GET",
"log-id": "c29d2f4f-07ca-46ab-877d-7522073604a0",
"username": "Username Not Provided",
"uri": "/restconf/data/adtran-feature-flags:feature-flags",
"status-code": "200 OK",
"req-time": "2020-05-06T06:20:34+00:00",
"content": "",
"ip-address": "172.22.182.150"
},
{
"method": "GET",
"log-id": "7c52cb34-8a97-41b1-a024-c80e0475fef4",
"username": "ADMIN",
"uri": "/restconf/data/adtran-cloud-platform-data-centers:data-centers/data-center=Data%20Center",
"status-code": "200 OK",
"req-time": "2020-05-06T06:18:05+00:00",
"content": "",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "73fcb00c-3074-4a9a-be8f-e7aaaf76262d",
"username": "{\"message\":\"Invalid token\"}",
"uri": "/restconf/operations/adtran-auth-token:release-token",
"status-code": "401 Unauthorized",
"req-time": "2020-05-06T06:17:59+00:00",
"content": "{}",
"ip-address": "172.22.181.204"
},
{
"method": "GET",
"log-id": "ae8b0d5c-43b6-49a5-81b4-9f18212cb051",
"username": "Username Not Provided",
"uri": "/restconf/data/adtran-launchpad-login:login-screen",
"status-code": "200 OK",
"req-time": "2020-05-06T06:17:59+00:00",
"content": "",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "ce5b34af-0e0e-41d5-87e7-0bbf9afedb97",
"username": "{\"message\":\"Invalid token\"}",
"uri": "/restconf/operations/adtran-auth-token:release-token",
"status-code": "401 Unauthorized",
"req-time": "2020-05-06T06:17:58+00:00",
"content": "{}",
"ip-address": "172.22.181.204"
},
{
"method": "GET",
"log-id": "a97b4920-3036-4973-9801-5dcaf0352d50",
"username": "ADMIN",
"uri": "/restconf/data/adtran-cloud-platform-data-centers:data-centers/data-center=Data-Center",
"status-code": "404 Not Found",
"req-time": "2020-05-06T06:17:57+00:00",
"content": "",
"ip-address": "172.22.181.204"
},
{
"method": "GET",
"log-id": "36ad2390-4ded-4939-8144-50651aa2e41b",
"username": "{\"message\":\"Anonymous access not authorized\"}",
"uri": "/restconf/data/adtran-cloud-platform-data-centers:data-centers/data-center=Data-Center",
"status-code": "401 Unauthorized",
"req-time": "2020-05-06T06:17:51+00:00",
"content": "",
"ip-address": "172.22.181.204"
},
{
"method": "GET",
"log-id": "c3129d6a-f172-4321-bc8c-bcf1a980d3fa",
"username": "ADMIN",
"uri": "/restconf/data/adtran-cloud-platform-data-centers:data-centers/data-center",
"status-code": "200 OK",
"req-time": "2020-05-06T05:48:32+00:00",
"content": "",
"ip-address": "172.22.181.204"
},
{
"method": "GET",
"log-id": "05f04aa9-5558-431a-a5ce-24eaa806ef52",
"username": "ADMIN",
"uri": "/restconf/data/adtran-cloud-platform-data-centers:data-centers/data-center",
"status-code": "200 OK",
"req-time": "2020-05-06T05:48:14+00:00",
"content": "{\r\n \"input\": {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Center\"\r\n }\r\n }\r\n}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "18447a00-f2f8-43cd-af8c-7f530b5bc2b7",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:activate",
"status-code": "200 OK",
"req-time": "2020-05-06T05:47:27+00:00",
"content": "{\r\n \"input\": {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Center\"\r\n }\r\n }\r\n}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "2ce89b2b-c301-48e3-9f2a-ee1bc540c00f",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:deploy",
"status-code": "200 OK",
"req-time": "2020-05-06T05:47:06+00:00",
"content": "{\r\n \"input\" : {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Center\",\r\n \"availability\" : \"available\"\r\n }\r\n }\r\n }",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "e9a6105b-14e7-479e-910b-3c0bda261e73",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:create",
"status-code": "400 Bad Request",
"req-time": "2020-05-06T05:46:59+00:00",
"content": "{\r\n \"input\" : {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Center\",\r\n \"availability\" : \"available\"\r\n }\r\n }\r\n }",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "0f801d6a-cdd1-45c8-b46d-e9ab2193930d",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:create",
"status-code": "200 OK",
"req-time": "2020-05-06T05:46:28+00:00",
"content": "{\r\n \"input\" : {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Center\",\r\n \"type\" : \"Generic\",\r\n \"profile-vector-name\" : \"\"\r\n }\r\n }\r\n }",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "6e1b01c0-0ada-48fa-b399-d47ba4799f25",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-search:search",
"status-code": "200 OK",
"req-time": "2020-05-06T05:45:46+00:00",
"content": "{\"input\":{\"type\":\"search-global\",\"related-objects-term\":{\"cursor\":0,\"result-size\":25,\"search-term\":\"\",\"object-type\":\"data-center\",\"search-field\":\"\",\"extra-search-fields\":[]}}}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "a942a399-1a24-4967-841d-a045f06bdb49",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-search:search",
"status-code": "200 OK",
"req-time": "2020-05-06T05:45:46+00:00",
"content": "{\"input\":{\"type\":\"search-global\",\"related-objects-term\":{\"cursor\":0,\"result-size\":25,\"search-term\":\"\",\"object-type\":\"data-center\",\"search-field\":\"\",\"extra-search-fields\":[]}}}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "93afbb02-10fd-40fb-a345-10adbfed4efa",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-search:search",
"status-code": "200 OK",
"req-time": "2020-05-06T05:45:46+00:00",
"content": "{\"input\":{\"type\":\"search-global\",\"related-objects-term\":{\"cursor\":0,\"result-size\":25,\"search-term\":\"\",\"object-type\":\"data-center\",\"search-field\":\"\",\"extra-search-fields\":[]}}}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "3cfd9859-5708-44d7-98cf-ada309cfff4a",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-search:search",
"status-code": "200 OK",
"req-time": "2020-05-06T05:45:45+00:00",
"content": "{\"input\":{\"type\":\"search-global\",\"related-objects-term\":{\"cursor\":0,\"result-size\":25,\"search-term\":\"\",\"object-type\":\"management-domain\",\"search-field\":\"\",\"extra-search-fields\":[]}}}",
"ip-address": "172.22.181.204"
},
{
"method": "GET",
"log-id": "f38b517f-9005-4ceb-93b3-af9fd394fc40",
"username": "{\"message\":\"All authorization methods failed\"}",
"uri": "/restconf/data/adtran-cloud-platform-data-centers:data-centers/Data%20Center",
"status-code": "404 Not Found",
"req-time": "2020-05-06T05:45:29+00:00",
"content": "",
"ip-address": "172.22.181.204"
},
{
"method": "GET",
"log-id": "e61e1a2f-5267-4e01-a2d1-9fe237212caf",
"username": "ADMIN",
"uri": "/restconf/data/adtran-cloud-platform-data-centers:data-centers/data-center",
"status-code": "200 OK",
"req-time": "2020-05-06T05:45:15+00:00",
"content": "",
"ip-address": "172.22.181.204"
},
{
"method": "GET",
"log-id": "990b1606-1881-4b3d-b4c1-0cd8197e5d67",
"username": "{\"message\":\"Anonymous access not authorized\"}",
"uri": "/restconf/data/adtran-cloud-platform-data-centers:data-centers/data-center",
"status-code": "401 Unauthorized",
"req-time": "2020-05-06T05:45:04+00:00",
"content": "",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "c570a2fb-38bb-490c-8678-c0b5d9be6a35",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-search:search",
"status-code": "200 OK",
"req-time": "2020-05-06T05:42:44+00:00",
"content": "{\"input\":{\"type\":\"search-global\",\"related-objects-term\":{\"cursor\":0,\"result-size\":25,\"search-term\":\"\",\"object-type\":\"data-center\",\"search-field\":\"\",\"extra-search-fields\":[]}}}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "d6f1b6fa-edb1-41e9-8c3b-5898950af9f9",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-search:search",
"status-code": "200 OK",
"req-time": "2020-05-06T05:42:44+00:00",
"content": "{\"input\":{\"type\":\"search-global\",\"related-objects-term\":{\"cursor\":0,\"result-size\":25,\"search-term\":\"\",\"object-type\":\"data-center\",\"search-field\":\"\",\"extra-search-fields\":[]}}}",
"ip-address": "172.22.181.204"
},
{
"method": "GET",
"log-id": "14bc8174-d644-40fe-bfd2-a6a550b51c06",
"username": "ADMIN",
"uri": "/restconf/data/adtran-manifests:versions",
"status-code": "200 OK",
"req-time": "2020-05-06T05:29:32+00:00",
"content": "",
"ip-address": "172.22.178.244"
},
{
"method": "POST",
"log-id": "2422fe05-ec29-4a78-bdf2-4a2dfae4769d",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:delete",
"status-code": "409 Conflict",
"req-time": "2020-05-06T05:28:50+00:00",
"content": "{\r\n \"input\": {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Center\"\r\n }\r\n }\r\n}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "bfff6437-7f8d-48eb-9892-8c19f298b40b",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:delete",
"status-code": "200 OK",
"req-time": "2020-05-06T05:27:36+00:00",
"content": "{\r\n \"input\": {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Center\"\r\n }\r\n }\r\n}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "428e0f6c-971b-4217-9898-b8decef66ff6",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:delete",
"status-code": "409 Conflict",
"req-time": "2020-05-06T05:26:56+00:00",
"content": "{\r\n \"input\": {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Center1\"\r\n }\r\n }\r\n}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "cb064332-9d23-41bf-af66-5a60416385c9",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:undeploy",
"status-code": "409 Conflict",
"req-time": "2020-05-06T05:25:25+00:00",
"content": "{\r\n \"input\": {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Center\"\r\n }\r\n }\r\n}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "39319b84-41b2-450b-a372-be3a6f5954e1",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-search:search",
"status-code": "200 OK",
"req-time": "2020-05-06T05:24:59+00:00",
"content": "{\"input\":{\"type\":\"search-global\",\"related-objects-term\":{\"cursor\":0,\"result-size\":25,\"search-term\":\"\",\"object-type\":\"data-center\",\"search-field\":\"\",\"extra-search-fields\":[]}}}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "c56d8541-2285-4daf-a294-bfe2accc672f",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-search:search",
"status-code": "200 OK",
"req-time": "2020-05-06T05:24:59+00:00",
"content": "{\"input\":{\"type\":\"search-global\",\"related-objects-term\":{\"cursor\":0,\"result-size\":25,\"search-term\":\"\",\"object-type\":\"data-center\",\"search-field\":\"\",\"extra-search-fields\":[]}}}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "1a9d8dc8-23ce-4e1f-9532-7c050af01a18",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:undeploy",
"status-code": "200 OK",
"req-time": "2020-05-06T05:24:52+00:00",
"content": "{\r\n \"input\": {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Center\"\r\n }\r\n }\r\n}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "2c616db5-1e7c-4d55-acfa-27fe51499be0",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:undeploy",
"status-code": "409 Conflict",
"req-time": "2020-05-06T05:24:11+00:00",
"content": "{\r\n \"input\": {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Center1\"\r\n }\r\n }\r\n}",
"ip-address": "172.22.181.204"
},
{
"method": "GET",
"log-id": "da310555-d4f4-4ac8-9eaa-56ac16ce45a6",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:undeploy",
"status-code": "405 Method Not Allowed",
"req-time": "2020-05-06T05:24:00+00:00",
"content": "{\r\n \"input\": {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Cente1r\"\r\n }\r\n }\r\n}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "3d2aea3b-d419-4e48-9c7a-4356c5238931",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:deactivate",
"status-code": "409 Conflict",
"req-time": "2020-05-06T05:15:58+00:00",
"content": "{\r\n \"input\": {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Center\"\r\n }\r\n }\r\n}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "1060cebe-2bc9-46f6-b864-0b9123d2e95f",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:deactivate",
"status-code": "200 OK",
"req-time": "2020-05-06T05:15:36+00:00",
"content": "{\r\n \"input\": {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Center\"\r\n }\r\n }\r\n}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "682e314c-dd2e-49ae-b86e-3a3162816ead",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:deactivate",
"status-code": "409 Conflict",
"req-time": "2020-05-06T05:15:00+00:00",
"content": "{\r\n \"input\": {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Center1\"\r\n }\r\n }\r\n}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "60dd0071-3918-4fdc-abfa-312baef2ba93",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:activate",
"status-code": "200 OK",
"req-time": "2020-05-06T05:11:15+00:00",
"content": "{\r\n \"input\": {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Center\"\r\n }\r\n }\r\n}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "ed790d2e-8b8e-437a-90d0-18996441d493",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:deactivate",
"status-code": "200 OK",
"req-time": "2020-05-06T05:11:09+00:00",
"content": "{\r\n \"input\": {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Center\"\r\n }\r\n }\r\n}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "7a47f030-c19b-47a5-8da1-c32777dce510",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:activate",
"status-code": "409 Conflict",
"req-time": "2020-05-06T05:10:45+00:00",
"content": "{\r\n \"input\": {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Center\"\r\n }\r\n }\r\n}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "da2f71c7-40ab-496b-b422-6c9916b1006f",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-search:search",
"status-code": "200 OK",
"req-time": "2020-05-06T05:10:21+00:00",
"content": "{\"input\":{\"type\":\"search-global\",\"related-objects-term\":{\"cursor\":0,\"result-size\":25,\"search-term\":\"\",\"object-type\":\"data-center\",\"search-field\":\"\",\"extra-search-fields\":[]}}}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "24e059d4-3c83-419c-b06b-1decf5a1dd0c",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-search:search",
"status-code": "200 OK",
"req-time": "2020-05-06T05:10:19+00:00",
"content": "{\"input\":{\"type\":\"search-global\",\"related-objects-term\":{\"cursor\":0,\"result-size\":25,\"search-term\":\"\",\"object-type\":\"content-provider\",\"search-field\":\"\",\"extra-search-fields\":[]}}}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "4f8bbf08-56c7-4813-a398-396e9516f381",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-search:search",
"status-code": "200 OK",
"req-time": "2020-05-06T05:10:19+00:00",
"content": "{\"input\":{\"type\":\"search-global\",\"related-objects-term\":{\"cursor\":0,\"result-size\":25,\"search-term\":\"\",\"object-type\":\"data-center\",\"search-field\":\"\",\"extra-search-fields\":[]}}}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "456e9811-5b89-4999-89c1-a2c8b36d0308",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-search:search",
"status-code": "200 OK",
"req-time": "2020-05-06T05:10:19+00:00",
"content": "{\"input\":{\"type\":\"search-global\",\"related-objects-term\":{\"cursor\":0,\"result-size\":25,\"search-term\":\"\",\"object-type\":\"data-center\",\"search-field\":\"\",\"extra-search-fields\":[]}}}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "9f22d9c9-9f38-4ebe-8aae-2a4479692a25",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:activate",
"status-code": "200 OK",
"req-time": "2020-05-06T05:10:13+00:00",
"content": "{\r\n \"input\": {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Center\"\r\n }\r\n }\r\n}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "9ff9a477-e0bb-4633-913d-ec678aa3e901",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:activate",
"status-code": "409 Conflict",
"req-time": "2020-05-06T05:09:36+00:00",
"content": "{\r\n \"input\": {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Center1\"\r\n }\r\n }\r\n}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "07dfe00d-0c32-4678-a8ee-57c47bb615cf",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:deploy",
"status-code": "200 OK",
"req-time": "2020-05-06T05:03:20+00:00",
"content": "{\r\n \"input\" : {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Center\",\r\n \"availability\" : \"available\"\r\n }\r\n }\r\n }",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "c5aaeb4d-450b-4f98-9af8-e43f0c4932c1",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:deploy",
"status-code": "409 Conflict",
"req-time": "2020-05-06T05:02:55+00:00",
"content": "{\r\n \"input\" : {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Center1\",\r\n \"availability\" : \"available\"\r\n }\r\n }\r\n }",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "730cfbc1-a93f-43f1-a5d6-63733f72ad44",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:undeploy",
"status-code": "200 OK",
"req-time": "2020-05-06T05:02:33+00:00",
"content": "{\r\n \"input\": {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Center\"\r\n }\r\n }\r\n}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "d08d2cdd-1957-47da-9000-79d9eabbf543",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:deploy",
"status-code": "409 Conflict",
"req-time": "2020-05-06T05:01:56+00:00",
"content": "{\r\n \"input\" : {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Center\",\r\n \"availability\" : \"available\"\r\n }\r\n }\r\n }",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "8687bdaa-a5cc-48c1-b22c-3648612ef793",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-search:search",
"status-code": "200 OK",
"req-time": "2020-05-06T05:01:04+00:00",
"content": "{\"input\":{\"type\":\"search-global\",\"related-objects-term\":{\"cursor\":0,\"result-size\":25,\"search-term\":\"\",\"object-type\":\"data-center\",\"search-field\":\"\",\"extra-search-fields\":[]}}}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "c9d68a1d-0298-461f-ae1b-cecdb095f1ff",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:deploy",
"status-code": "200 OK",
"req-time": "2020-05-06T05:00:55+00:00",
"content": "{\r\n \"input\" : {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Center\",\r\n \"availability\" : \"available\"\r\n }\r\n }\r\n }",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "1e65bbd9-d01f-4fa0-83dd-47024134ab02",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:deploy",
"status-code": "409 Conflict",
"req-time": "2020-05-06T05:00:47+00:00",
"content": "{\r\n \"input\" : {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Center2\",\r\n \"availability\" : \"available\"\r\n }\r\n }\r\n }",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "4f746489-eda0-47e7-b83d-1af531cd1304",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:deploy",
"status-code": "409 Conflict",
"req-time": "2020-05-06T05:00:29+00:00",
"content": "{\r\n \"input\" : {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Center 2\",\r\n \"availability\" : \"available\"\r\n }\r\n }\r\n }",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "dafa2b00-6d24-41cb-a496-05cac34ba4bb",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:create",
"status-code": "200 OK",
"req-time": "2020-05-06T04:49:25+00:00",
"content": "{\r\n \"input\" : {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Center\",\r\n \"type\" : \"Generic\",\r\n \"profile-vector-name\" : \"\"\r\n }\r\n }\r\n }",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "7ee8d9d7-a893-47a9-82f0-4c360c2cb8a9",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:create",
"status-code": "400 Bad Request",
"req-time": "2020-05-06T04:49:02+00:00",
"content": "{\r\n \"input\" : {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Center\",\r\n \"types\" : \"Generic\",\r\n \"profile-vector-name\" : \"\"\r\n }\r\n }\r\n }",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "f15c9b10-9dc3-492e-bf20-f5f1097e6d86",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:delete",
"status-code": "200 OK",
"req-time": "2020-05-06T04:48:15+00:00",
"content": "{\r\n \"input\": {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Center\"\r\n }\r\n }\r\n}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "121418ba-4b37-4df3-9ed8-5693255164b9",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-search:search",
"status-code": "200 OK",
"req-time": "2020-05-06T04:47:54+00:00",
"content": "{\"input\":{\"type\":\"search-global\",\"related-objects-term\":{\"cursor\":0,\"result-size\":25,\"search-term\":\"\",\"object-type\":\"data-center\",\"search-field\":\"\",\"extra-search-fields\":[]}}}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "5a24b044-070a-483c-80c1-582e6037d9a7",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:create",
"status-code": "200 OK",
"req-time": "2020-05-06T04:40:44+00:00",
"content": "{\r\n \"input\" : {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Center\",\r\n \"type\" : \"Generic\",\r\n \"profile-vector-names\" : \"\"\r\n }\r\n }\r\n }",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "49a55c6e-83fb-4d26-b996-1ac767ecf16c",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:create",
"status-code": "400 Bad Request",
"req-time": "2020-05-06T04:40:37+00:00",
"content": "{\r\n \"input\" : {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Center\",\r\n \"types\" : \"Generic\",\r\n \"profile-vector-names\" : \"\"\r\n }\r\n }\r\n }",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "f08839ba-8b99-40ca-a4a8-8ec5ca6ccde7",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:create",
"status-code": "400 Bad Request",
"req-time": "2020-05-06T04:40:21+00:00",
"content": "{\r\n \"input\" : {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Center\",\r\n \"types\" : \"Generic\",\r\n \"profile-vector-name\" : \"\"\r\n }\r\n }\r\n }",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "935e96c0-5f3c-46d9-bef4-59ca486aad00",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:delete",
"status-code": "200 OK",
"req-time": "2020-05-06T04:39:25+00:00",
"content": "{\r\n \"input\": {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Center\"\r\n }\r\n }\r\n}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "37e6c112-f751-4b19-9eaa-3d5e78d50f65",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:create",
"status-code": "200 OK",
"req-time": "2020-05-06T04:39:02+00:00",
"content": "{\r\n \"input\" : {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Center\",\r\n \"type\" : \"Generic\",\r\n \"profile-vector-name\" : \"Vector Name\"\r\n }\r\n }\r\n }",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "d50d4e7b-3f49-45d2-a853-d91f3a2e05fe",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:delete",
"status-code": "200 OK",
"req-time": "2020-05-06T04:38:31+00:00",
"content": "{\r\n \"input\": {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Center\"\r\n }\r\n }\r\n}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "11d966b7-5fd0-4a89-9a3e-dc7cda5cbc74",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:create",
"status-code": "200 OK",
"req-time": "2020-05-06T04:37:26+00:00",
"content": "{\r\n \"input\" : {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Center\",\r\n \"type\" : \"GenericCase\",\r\n \"profile-vector-name\" : \"\"\r\n }\r\n }\r\n }",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "5da9e31e-74af-4f86-88d0-55d52c3c64b5",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-search:search",
"status-code": "200 OK",
"req-time": "2020-05-06T04:36:34+00:00",
"content": "{\"input\":{\"type\":\"search-global\",\"related-objects-term\":{\"cursor\":0,\"result-size\":25,\"search-term\":\"\",\"object-type\":\"data-center\",\"search-field\":\"\",\"extra-search-fields\":[]}}}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "96220e7a-9ef2-4494-9510-a0f55ae09136",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-search:search",
"status-code": "200 OK",
"req-time": "2020-05-06T04:36:34+00:00",
"content": "{\"input\":{\"type\":\"search-global\",\"related-objects-term\":{\"cursor\":0,\"result-size\":25,\"search-term\":\"\",\"object-type\":\"data-center\",\"search-field\":\"\",\"extra-search-fields\":[]}}}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "a2364a72-9ba7-42a2-9175-3b864858f89c",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:delete",
"status-code": "200 OK",
"req-time": "2020-05-06T04:36:28+00:00",
"content": "{\r\n \"input\": {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Centre\"\r\n }\r\n }\r\n}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "b1c22992-da7b-416c-97d7-43109573dfea",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:undeploy",
"status-code": "409 Conflict",
"req-time": "2020-05-06T04:36:12+00:00",
"content": "{\r\n \"input\": {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Centre\"\r\n }\r\n }\r\n}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "4a12cd9e-d2f1-437a-b376-bc88a7ae5ee5",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:create",
"status-code": "409 Conflict",
"req-time": "2020-05-06T04:35:02+00:00",
"content": "{\r\n \"input\" : {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Centre\",\r\n \"type\" : \"Generic\",\r\n \"profile-vector-name\" : \"\"\r\n }\r\n }\r\n }",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "44a89a3f-f5f2-46b5-9a75-65e869787bf6",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-search:search",
"status-code": "200 OK",
"req-time": "2020-05-06T04:33:46+00:00",
"content": "{\"input\":{\"type\":\"search-global\",\"related-objects-term\":{\"cursor\":0,\"result-size\":25,\"search-term\":\"\",\"object-type\":\"data-center\",\"search-field\":\"\",\"extra-search-fields\":[]}}}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "794ba004-9916-4faa-8c97-f1be3fc3a1d0",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-search:search",
"status-code": "200 OK",
"req-time": "2020-05-06T04:33:45+00:00",
"content": "{\"input\":{\"type\":\"search-global\",\"related-objects-term\":{\"cursor\":0,\"result-size\":25,\"search-term\":\"\",\"object-type\":\"data-center\",\"search-field\":\"\",\"extra-search-fields\":[]}}}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "556818aa-1962-475c-84f5-12e62f9ab027",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-search:search",
"status-code": "200 OK",
"req-time": "2020-05-06T04:33:45+00:00",
"content": "{\"input\":{\"type\":\"search-global\",\"related-objects-term\":{\"cursor\":0,\"result-size\":25,\"search-term\":\"\",\"object-type\":\"data-center\",\"search-field\":\"\",\"extra-search-fields\":[]}}}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "37d8c035-ff18-4580-8706-34833719e8d9",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-search:search",
"status-code": "200 OK",
"req-time": "2020-05-06T04:33:44+00:00",
"content": "{\"input\":{\"type\":\"search-global\",\"related-objects-term\":{\"cursor\":0,\"result-size\":25,\"search-term\":\"\",\"object-type\":\"server\",\"search-field\":\"\",\"extra-search-fields\":[]}}}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "1751b179-40ef-4ed9-902b-04017ff60ab1",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-search:search",
"status-code": "200 OK",
"req-time": "2020-05-06T04:33:44+00:00",
"content": "{\"input\":{\"type\":\"search-global\",\"related-objects-term\":{\"cursor\":0,\"result-size\":25,\"search-term\":\"\",\"object-type\":\"server\",\"search-field\":\"\",\"extra-search-fields\":[]}}}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "9fb63ff7-47c6-452a-ad6f-d73a5af5cfaf",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-search:search",
"status-code": "200 OK",
"req-time": "2020-05-06T04:33:44+00:00",
"content": "{\"input\":{\"type\":\"search-global\",\"related-objects-term\":{\"cursor\":0,\"result-size\":25,\"search-term\":\"\",\"object-type\":\"server\",\"search-field\":\"\",\"extra-search-fields\":[]}}}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "77727a27-de44-441c-b41a-446c9e1a68a5",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:create",
"status-code": "200 OK",
"req-time": "2020-05-06T04:33:35+00:00",
"content": "{\r\n \"input\" : {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Centre\",\r\n \"type\" : \"Generic\",\r\n \"profile-vector-name\" : \"\"\r\n }\r\n }\r\n }",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "2716ef60-2c2e-479b-b735-769e1e596f67",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-event-workflow:get-events",
"status-code": "200 OK",
"req-time": "2020-05-06T04:33:29+00:00",
"content": "{\"input\":{\"summary-field\":\"severity\",\"current\":true,\"cursor\":0,\"result-size\":25,\"exact-match\":true}}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "ca4a33a1-5dc3-4b4b-a3b3-f6620b382860",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-event-workflow:get-event-summary",
"status-code": "200 OK",
"req-time": "2020-05-06T04:33:27+00:00",
"content": "{\"input\":{\"summary-field\":\"severity\",\"exact-match\":true}}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "72dddde9-3ffd-4de1-9178-497f6673ac07",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-event-workflow:get-events",
"status-code": "200 OK",
"req-time": "2020-05-06T04:33:27+00:00",
"content": "{\"input\":{\"summary-field\":\"severity\",\"current\":true,\"cursor\":0,\"result-size\":25,\"exact-match\":true}}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "bdf9a7d9-c33a-4438-b449-eee0f0bd2eb8",
"username": "ADMIN",
"uri": "/restconf/operations/adtran-cloud-platform-event-workflow:get-events",
"status-code": "200 OK",
"req-time": "2020-05-06T04:33:27+00:00",
"content": "{\"input\":{\"summary-field\":\"severity\",\"current\":true,\"cursor\":0,\"result-size\":25,\"exact-match\":true}}",
"ip-address": "172.22.181.204"
},
{
"method": "GET",
"log-id": "f803fc87-2ed5-4f4b-9ad0-bfe8da591c55",
"username": "Username Not Provided",
"uri": "/restconf/data/adtran-launchpad-login:login-screen",
"status-code": "200 OK",
"req-time": "2020-05-06T04:33:26+00:00",
"content": "",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "07d565b7-f91d-4e90-9def-c041c28866e1",
"username": "Username Not Provided",
"uri": "/restconf/operations/adtran-auth-token:request-token",
"status-code": "200 OK",
"req-time": "2020-05-06T04:33:26+00:00",
"content": "{\"password\":\"********\",\"username\":\"ADMIN\"}",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "4cc7546a-6857-4799-aac4-b27f1da45499",
"username": "Username Not Provided",
"uri": "/restconf/operations/adtran-auth-user:reset-password",
"status-code": "200 OK",
"req-time": "2020-05-06T04:33:25+00:00",
"content": "{\"new-password\":\"********\",\"old-password\":\"********\",\"username\":\"ADMIN\"}",
"ip-address": "172.22.181.204"
},
{
"method": "GET",
"log-id": "2852d80f-ff94-4e28-916b-d69f8e580b09",
"username": "Username Not Provided",
"uri": "/restconf/data/adtran-launchpad-login:login-screen",
"status-code": "200 OK",
"req-time": "2020-05-06T04:33:16+00:00",
"content": "",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "bca8bfcc-3b59-438a-bd68-c25694b640ed",
"username": "Username Not Provided",
"uri": "/restconf/operations/adtran-auth-token:request-token",
"status-code": "401 Unauthorized",
"req-time": "2020-05-06T04:33:16+00:00",
"content": "{\"password\":\"********\",\"username\":\"ADMIN\"}",
"ip-address": "172.22.181.204"
},
{
"method": "GET",
"log-id": "c7dea737-ac75-4e1a-8f1e-a863deecbc00",
"username": "Username Not Provided",
"uri": "/restconf/data/adtran-launchpad-login:login-screen",
"status-code": "200 OK",
"req-time": "2020-05-06T04:33:07+00:00",
"content": "",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "1f00abcd-1cfa-4529-b1d1-38d6ae19ce26",
"username": "Username Not Provided",
"uri": "/restconf/operations/adtran-auth-token:request-token",
"status-code": "401 Unauthorized",
"req-time": "2020-05-06T04:33:07+00:00",
"content": "{\"password\":\"********\",\"username\":\"ADMIN\"}",
"ip-address": "172.22.181.204"
},
{
"method": "GET",
"log-id": "ded01199-9be8-4354-ae0c-4ae1e3bbbcac",
"username": "Username Not Provided",
"uri": "/restconf/data/adtran-launchpad-login:login-screen",
"status-code": "200 OK",
"req-time": "2020-05-06T04:32:34+00:00",
"content": "",
"ip-address": "172.22.181.204"
},
{
"method": "GET",
"log-id": "e2acbb30-6e7a-4411-8eae-2bf2652ba99b",
"username": "Username Not Provided",
"uri": "/restconf/data/adtran-launchpad-login:login-screen",
"status-code": "200 OK",
"req-time": "2020-05-06T04:32:31+00:00",
"content": "",
"ip-address": "172.22.181.204"
},
{
"method": "GET",
"log-id": "55955e4d-e1e2-4439-9dc5-19b945121535",
"username": "Username Not Provided",
"uri": "/restconf/data/adtran-feature-flags:feature-flags",
"status-code": "200 OK",
"req-time": "2020-05-06T04:32:30+00:00",
"content": "",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "7589b971-9ab2-4d5d-a788-940ec9d97421",
"username": "{\"message\":\"Failed authentication\"}",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:create",
"status-code": "401 Unauthorized",
"req-time": "2020-05-06T04:31:47+00:00",
"content": "{\r\n \"input\" : {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Centre\",\r\n \"type\" : \"Generic\",\r\n \"profile-vector-name\" : \"\"\r\n }\r\n }\r\n }",
"ip-address": "172.22.181.204"
},
{
"method": "POST",
"log-id": "15a68fc0-ba57-4939-af6e-7e50eea85b58",
"username": "{\"message\":\"Anonymous access not authorized\"}",
"uri": "/restconf/operations/adtran-cloud-platform-uiworkflow:create",
"status-code": "401 Unauthorized",
"req-time": "2020-05-06T04:31:34+00:00",
"content": "{\r\n \"input\" : {\r\n \"data-center-context\": {\r\n \"data-center-name\": \"Data Centre\",\r\n \"type\" : \"Generic\",\r\n \"profile-vector-name\" : \"\"\r\n }\r\n }\r\n }",
"ip-address": "172.22.181.204"
}
],
"cursor": 178,
"total-count": 178
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-credentials:credentials/credential": {
"post": {
"tags": [
"Credentials"
],
"summary": "Create Credential",
"description": "This API sets the credentials to be used for network element management.\n\n----\n### Note\n* Different set of network elements can have different credentials\n\n| Attribute | Description |\n| --- | --- |\n| name | **Required:** A user configurable name for the credentials. Upon creation of the credential, the associated name will default to a unique value. |\n| Authenticate Type | **Required:** Means to create credential (see options below). Possible types: password-authentication Network element can be accessed using password key-authentication Network element can be accessed using a token key password-only-authentication Authentication parameters for access without username. |\n| password-authentication | username : Username for access to the network element.password : Password for access to the network element. |\n| key-authentication | username : Username for access to the network element.key : key for access to the network element. |\n| password-only-authentication | password : Authentication parameters for access without username.|",
"operationId": "CreateCredential",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateCredentialRequest"
},
"example": {
"name": "credential_1",
"key-authentication": {
"username": "root",
"key": "{{basic-auth-password}}"
}
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Wed, 06 May 2020 08:50:28 GMT"
},
"example": "Wed, 06 May 2020 08:50:28 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "0"
},
"example": "0"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "no-store"
},
"example": "no-store"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "\"7a4880ce-b67e-4b21-8eb5-02b2d88774f1\""
},
"example": "\"7a4880ce-b67e-4b21-8eb5-02b2d88774f1\""
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {}
},
"409": {
"description": "Conflict",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Wed, 06 May 2020 08:50:49 GMT"
},
"example": "Wed, 06 May 2020 08:50:49 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "118"
},
"example": "118"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/CreateCredential-AlreadyExists1"
},
"example": {
"message": "Cannot overwrite path List(adtran-cloud-platform-credentials, credentials, credential=credential_1)"
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-credentials:credentials/credential=credential_2": {
"put": {
"tags": [
"Credentials"
],
"summary": "Update Credential Password Only Authentication",
"description": "This API sets the credentials to be used for network element management.\n\n----\n### Note\n* Different set of network elements can have different credentials\n\n| Attribute | Description |\n| --- | --- |\n| name | **Required:** A user configurable name for the credentials. Upon creation of the credential, the associated name will default to a unique value. |\n| Authenticate Type | **Required:** Means to create credential (see options below). Possible types: password-authentication Network element can be accessed using password key-authentication Network element can be accessed using a token key password-only-authentication Authentication parameters for access without username. |\n| password-authentication | username : Username for access to the network element.password : Password for access to the network element. |\n| key-authentication | username : Username for access to the network element.key : key for access to the network element. |\n| password-only-authentication | password : Authentication parameters for access without username.|",
"operationId": "UpdateCredentialPasswordOnlyAuthentication",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCredentialPasswordOnlyAuthenticationRequest"
},
"example": {
"name": "credential_2",
"password-only-authentication": {
"password": "P@ssw0rd1"
}
}
}
},
"required": true
},
"responses": {
"default": {
"description": "",
"headers": {},
"content": {}
}
},
"deprecated": false
},
"delete": {
"tags": [
"Credentials"
],
"summary": "Delete Credential Password Only",
"description": "Delete external authentication configurations. The name of the Policy to delete is specified in the URL.",
"operationId": "DeleteCredentialPasswordOnly",
"parameters": [],
"responses": {
"default": {
"description": "",
"headers": {},
"content": {}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-credentials:credentials/credential=credential_1": {
"get": {
"tags": [
"Credentials"
],
"summary": "Get Credentials By Name",
"description": "Fetches credential by name. Depending on the type of credential, the output will vary. See below.\n\n| Attribute | Description |\n| --- | --- |\n| name | This represents unique name of the credential. |\n| password-authentication | Authentication parameters for network element access. username: This represents username for access to the network element. password: This represents password for access to the network element. |\n| key-authentication | Key authentication parameters for network element access. username: This represents username for access to the network element. password: This represents key for access to the network element. |",
"operationId": "GetCredentialsByName",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 08 May 2020 17:35:07 GMT"
},
"example": "Fri, 08 May 2020 17:35:07 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "94"
},
"example": "94"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "private, no-cache"
},
"example": "private, no-cache"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "\"f3b38ea6-0a91-41b9-95fb-8362cb01b5af\""
},
"example": "\"f3b38ea6-0a91-41b9-95fb-8362cb01b5af\""
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/GetCredentialsByName-Success"
},
"example": {
"name": "OLT Credentials",
"password-authentication": {
"username": "hsvroot",
"password": "BOSCO"
}
}
}
}
}
},
"deprecated": false
},
"delete": {
"tags": [
"Credentials"
],
"summary": "Delete Credential",
"description": "This API deletes the credential by name in the URL parameter.",
"operationId": "DeleteCredential",
"parameters": [],
"responses": {
"404": {
"description": "Not Found",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Wed, 06 May 2020 09:40:14 GMT"
},
"example": "Wed, 06 May 2020 09:40:14 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "111"
},
"example": "111"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/DeleteCredential-IncorrectCredentialNotExists1"
},
"example": {
"message": "Could not find path List(adtran-cloud-platform-credentials, credentials, credential=invalid)"
}
}
}
},
"204": {
"description": "No Content",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Wed, 06 May 2020 09:39:41 GMT"
},
"example": "Wed, 06 May 2020 09:39:41 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "0"
},
"example": "0"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "no-store"
},
"example": "no-store"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "\"9abddfde-2e8c-40ee-b3f3-5e020ad9edbb\""
},
"example": "\"9abddfde-2e8c-40ee-b3f3-5e020ad9edbb\""
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-credentials:credentials": {
"get": {
"tags": [
"Credentials"
],
"summary": "Get All Credentials",
"description": "Fetches a list of credentials configured in the system. Returns a list of attributes as a response.\n\n| Attribute | Description |\n| --- | --- |\n| name | This represents unique name of the credential. |\n| password-authentication | Authentication parameters for network element access. username: This represents username for access to the network element. password: This represents password for access to the network element. |\n| key-authentication | Key authentication parameters for network element access. username: This represents username for access to the network element. password: This represents key for access to the network element. |",
"operationId": "GetAllCredentials",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 08 May 2020 11:08:15 GMT"
},
"example": "Fri, 08 May 2020 11:08:15 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "324"
},
"example": "324"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "private, no-cache"
},
"example": "private, no-cache"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "\"3f3ebc86-18c4-4ac9-b9da-38c2ca92a914\""
},
"example": "\"3f3ebc86-18c4-4ac9-b9da-38c2ca92a914\""
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/GetCredentials-Success"
},
"example": {
"credentials": {
"credential": [
{
"name": "OLT Credentials",
"password-authentication": {
"username": "root",
"password": "password"
}
},
{
"name": "SFTP Server Credentials",
"password-authentication": {
"username": "adtran",
"password": "netvanta"
}
},
{
"name": "pmaa-default",
"password-authentication": {
"username": "adtran",
"password": "adtran"
}
}
]
}
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-auth-config-external:auth-methods/auth-method": {
"post": {
"tags": [
"Policy"
],
"summary": "Create External Policy - RADIUS",
"description": "Create external authentication configurations using RADIUS as the authentication method.\n\n \nURL Request query parameter details - \n \n\n| Attribute | Description |\n| --- | --- |\n| auth-method | **Required** Name of the authentication method which defines external authentication configuration. Set to `radius`. |\n\nRequest body details -\n \n\n| Attributes | Description |\n| --- | --- |\n| name | Name of authentication method. |\n| retry-times | Number of times authentication can be attempted with this method. Possible values: 0..255 |\n| use-for-non-local-users | If true, this auth method will be tried for users who are not configured locally in MCP. If false (default), it will only be tried for users that also exist locally. Default value: false Possible values true or false |\n| accounting-port | The accounting port for authentication server. |\n| host | Unique host for authentication server. |\n| auth-port | The authentication port for authentication server. |\n| timeout | The timeout for authentication server. Possible values: 0.. 4,294,967,295 |\n| shared-secret-credential | The credentials must use password-only authentication. This value is a string. |",
"operationId": "CreateExternalPolicy-RADIUS",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateExternalPolicy-RADIUSRequest"
},
"example": {
"name": "test-policy",
"retry-times": 2,
"use-for-non-local-users": true,
"radius": {
"host": "10.2.1.1",
"auth-port": 1812,
"timeout": 200,
"shared-secret-credential": "credential_2",
"accounting-port": 1813
}
}
}
},
"required": true
},
"responses": {
"409": {
"description": "Conflict",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 08 May 2020 12:11:26 GMT"
},
"example": "Fri, 08 May 2020 12:11:26 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "83"
},
"example": "83"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/CreateExternalAuthMethod-Methodalreadyexists1"
},
"example": {
"message": "Cannot overwrite path List(adtran-auth-config-external, auth-methods)"
}
}
}
},
"201": {
"description": "Created",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 08 May 2020 12:12:53 GMT"
},
"example": "Fri, 08 May 2020 12:12:53 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "0"
},
"example": "0"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "no-store"
},
"example": "no-store"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "\"b282535d-c774-42bb-b697-7e9c01f10136\""
},
"example": "\"b282535d-c774-42bb-b697-7e9c01f10136\""
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {}
}
},
"deprecated": false
}
},
"/data/adtran-auth-config-external:auth-methods/auth-method=test-policy": {
"put": {
"tags": [
"Policy"
],
"summary": "Update External Policy - RADIUS",
"description": "This API defines external authentication configuration update.\n\n \nURL Request query parameter details - \n \n\n| Attribute | Description |\n| --- | --- |\n| auth-method | **Required** Name of the authentication method which defines external authentication configuration. Set to `radius`. |\n\n \nRequest body details - \n \n\n| Attribute | Description |\n| --- | --- |\n| name | **Required** Name of the authentication method. |\n| retry-times | Number of times authentication can be attempted with this method. |\n| use-for-non-local-users | If true, this auth method will be tried for users who are not configured locally in MCP. If false (default), it will only be tried for users that also exist locally. Default Value: false |\n| host | The unique host for authentication server. |\n| auth-port | The authentication port for authentication server. |\n| timeout | The timeout for authentication server. |\n| shared-secret-credential | The credentials must use password-only authentication. This value is a string. |",
"operationId": "UpdateExternalPolicy-RADIUS",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateExternalPolicy-RADIUSRequest"
},
"example": {
"name": "test-policy",
"retry-times": 2,
"use-for-non-local-users": true,
"radius": {
"host": "10.2.1.1",
"auth-port": 1812,
"timeout": 6000,
"shared-secret-credential": "credential_2",
"accounting-port": 1813
}
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 05 Jan 2021 19:24:33 GMT"
},
"example": "Tue, 05 Jan 2021 19:24:33 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "\"70bfda4f-60ef-4b46-a345-f53690e5ea89\""
},
"example": "\"70bfda4f-60ef-4b46-a345-f53690e5ea89\""
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "no-store"
},
"example": "no-store"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
}
},
"content": {}
}
},
"deprecated": false
},
"delete": {
"tags": [
"Policy"
],
"summary": "Delete External Policy - RADIUS",
"description": "Delete external authentication configurations. The name of the Policy to delete is specified in the URL.",
"operationId": "DeleteExternalPolicy-RADIUS",
"parameters": [],
"responses": {
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteExternalPolicy-PolicyDoesntExist1"
},
"example": {
"message": "Could not find path List(adtran-auth-config-external, auth-methods, auth-method=test-policy-not-exists)"
}
}
}
},
"204": {
"description": "No Content",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 27 Oct 2020 16:15:19 GMT"
},
"example": "Tue, 27 Oct 2020 16:15:19 GMT"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "\"0342a8d0-8224-475c-b4fc-3aad6fc0e0fd\""
},
"example": "\"0342a8d0-8224-475c-b4fc-3aad6fc0e0fd\""
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "no-store"
},
"example": "no-store"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
}
},
"content": {}
}
},
"deprecated": false
}
},
"/data/adtran-auth-config-external:auth-methods/auth-method=test-policy-2": {
"put": {
"tags": [
"Policy"
],
"summary": "Update External Policy - TACACS+",
"description": "This API defines external authentication configuration update.\n\n \nRequest query parameter details - \n \n\n| Attribute | Description |\n| --- | --- |\n| auth-method | **Required** Name of the authentication method which defines external authentication configuration. Set to `tacacsplus`. |\n\n \nURL Request body details - \n \n\n| Attribute | Description |\n| --- | --- |\n| name | **Required** Name of the authentication method. |\n| retry-times | Number of times authentication can be attempted with this method. |\n| use-for-non-local-users | If true, this auth method will be tried for users who are not configured locally in MCP. If false (default), it will only be tried for users that also exist locally. Default Value: false |\n| tacacsplus | Collection of all tacacsplus server specific configuration parameters. |\n| host | The unique host for authentication server. |\n| auth-port | The authentication port for authentication server. |\n| timeout | The timeout for authentication server. |\n| shared-secret-credential | The credentials must use password-only authentication. This value is a string. |\n| single-connect | TACACS+ single connect. Possible values: true, false |",
"operationId": "UpdateExternalPolicy-TACACS+",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateExternalPolicy-TACACSRequest"
},
"example": {
"name": "test-policy-2",
"retry-times": 5,
"use-for-non-local-users": true,
"tacacsplus": {
"host": "10.27.28.44",
"auth-port": 49,
"timeout": 7000,
"shared-secret-credential": "credential_2",
"single-connect": true
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "Bad Request",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Mon, 11 May 2020 13:13:37 GMT"
},
"example": "Mon, 11 May 2020 13:13:37 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "93"
},
"example": "93"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/ExternalPolicy-IncorrectAuth-Method1"
},
"example": {
"message": "Expected keys 'List(name)' to match in both the path and the document"
}
}
}
},
"201": {
"description": "Created",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Mon, 11 May 2020 10:12:16 GMT"
},
"example": "Mon, 11 May 2020 10:12:16 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "0"
},
"example": "0"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "no-store"
},
"example": "no-store"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "\"b1b00f72-2f42-44a7-891d-f57670d1f5f2\""
},
"example": "\"b1b00f72-2f42-44a7-891d-f57670d1f5f2\""
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {}
}
},
"deprecated": false
},
"delete": {
"tags": [
"Policy"
],
"summary": "Delete External Policy - TACACS+",
"description": "Delete external authentication configurations. The name of the Policy to delete is specified in the URL.",
"operationId": "DeleteExternalPolicy-TACACS+",
"parameters": [],
"responses": {
"default": {
"description": "",
"headers": {},
"content": {}
}
},
"deprecated": false
}
},
"/data/adtran-auth-config-external:auth-methods/auth-method=test-policy-3": {
"get": {
"tags": [
"Policy"
],
"summary": "Get External Policy",
"description": "Fetches a list of external authentication configurations. Returns a list of attributes as a response.\n\n \nURL Request query parameter details - \n \n\n| Attribute | Description |\n| --- | --- |\n| auth-method | **Required** Name of the authentication method which defines external authentication configuration. Set to `radius`, `tacacsplus`, or `internal`. |\n\nRequest body details -\n \n\n| Attribute | Description |\n| --- | --- |\n| name | This represents the name of authentication method. |\n| retry-times |\tNumber of times authentication can be attempted with this method. Possible values: 0...255 |\n| use-for-non-local-users | If true, this auth method will be tried for users who are not configured locally in MCP. If false (default), it will only be tried for users that also exist locally. Default value: false Possible values true or false |\n| radius | Collection of all radius server specific configuration parameters. |\n| accounting-port |\tThe accounting port for authentication server. |\n| host |\tThis represents unique host for authentication server. |\n| auth-port |\tThe authentication port for authentication server. |\n| timeout |\tThe timeout for authentication server. Possible values: 0..4,294,967,295 |\n| shared-secret-credential | The credentials must use password-only authentication. This value is a string. |\n| single-connect |\tTACACS+ single connect. Possible values: true, false |\n| internal |\tUse internal authentication. Possible values: [null] |",
"operationId": "GetExternalPolicy",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Thu, 01 Apr 2021 21:02:09 GMT"
},
"example": "Thu, 01 Apr 2021 21:02:09 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Vary": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
},
"example": "Accept-Encoding"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "W/\"34360b75-37fc-4cc8-8d86-ab0cf8df875f\""
},
"example": "W/\"34360b75-37fc-4cc8-8d86-ab0cf8df875f\""
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "private, no-cache"
},
"example": "private, no-cache"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "gzip"
},
"example": "gzip"
}
}
}
},
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/GetExternalPolicy-Success"
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-launchpad-login:login-screen": {
"put": {
"tags": [
"Login Banner"
],
"summary": "Update Login Banner",
"description": "Container for a user interface's login screen settings. This information will be visible on a login screen prior to authentication, so anonymous users will have access to this data.\n\n \nRequest Payload Details\n\n\n\n| Attribute | Description |\n|---|---|\n| banner-message | A message to display on a login screen prior to a user login. If no message or an empty message is provided, no message will display and the login screen will be unaltered from its regular appearance. Possible values: string with range 0..8192 |\n| admin-contact | Holds the email address of the system's administrative contact. This information will be accessible from the login page as a help mechanism. If empty or absent, no contact mechanism will be provided to users. Possible values: string with range 0..255 |",
"operationId": "UpdateLoginBanner",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateLoginBannerRequest"
},
"example": {
"login-screen": {
"banner-message": "{{login-banner-message}}",
"admin-contact": "{{login-banner-email}}"
}
}
}
},
"required": true
},
"responses": {
"204": {
"description": "No Content",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Mon, 11 May 2020 11:45:30 GMT"
},
"example": "Mon, 11 May 2020 11:45:30 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "0"
},
"example": "0"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "no-store"
},
"example": "no-store"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "\"f79cc8b5-032f-451f-9f46-252fa6c115e9\""
},
"example": "\"f79cc8b5-032f-451f-9f46-252fa6c115e9\""
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {}
}
},
"deprecated": false
},
"get": {
"tags": [
"Login Banner"
],
"summary": "Get Login Banner",
"description": "Get the user interface's login screen settings. This information will be visible on a login screen prior to authentication, so anonymous users will have access to this data.\n\n**Response Details**\n\n| Attribute | Description |\n|---|---|\n| banner-message |\tA message to display on a login screen prior to a user login. If no message or an empty message is provided, no message will display and the login screen will be unaltered from its regular appearance. Possible values:string with length 0..8192 |\n| admin-contact | Holds the email address of the system's administrative contact. This information will be accessible from the login page as a help mechanism. If empty or absent, no contact mechanism will be provided to users. Possible values:string with length 0..255 |",
"operationId": "GetLoginBanner",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 08 May 2020 11:03:56 GMT"
},
"example": "Fri, 08 May 2020 11:03:56 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "398"
},
"example": "398"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "private, no-cache"
},
"example": "private, no-cache"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "\"da156834-6098-44a6-9a33-f89adbab067b\""
},
"example": "\"da156834-6098-44a6-9a33-f89adbab067b\""
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/GetLoginBanner"
},
"example": {
"login-screen": {
"banner-message": "ADTRAN is a leading global provider of networking and communications equipment.\n\nOur products enable voice, data, video and Internet communications across a variety of network infrastructures. Our solutions are currently in use by service providers, private enterprises, government organizations and millions of individual users worldwide.",
"admin-contact": ""
}
}
}
}
}
},
"deprecated": false
}
},
"/operations/adtran-cloud-platform-elasticsearch-rollover-indices:schedule-rollover-attempt": {
"post": {
"tags": [
"Elasticsearch Rollover"
],
"summary": "Schedule Rollover",
"description": "Configures the cron expression of the PIN script which attempts to call rollover on indices at configured cron interval.\n\n \nRequest Payload Details\n\n\n\n| Attributes | Description |\n|---|---|\n|cron-expression|The cron expression indicating the time and frequency the scheduled cron job runs. Cron Format ``*`` minute:\t0-59 ``*`` hour:\t0-23 ``*``day of month:\t1-31 ``*``month:\t1-12 or JAN-DEC ``*``day of week:\t0-6 or SUN-SAT |",
"operationId": "ScheduleRollover",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleRolloverRequest"
},
"example": {
"input": {
"cron-expression": "0 0 0/6 * * ? *"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 08 May 2020 10:25:22 GMT"
},
"example": "Fri, 08 May 2020 10:25:22 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "74"
},
"example": "74"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/ScheduleRollover"
},
"example": {
"message": "Updated cron-expression for rollover attempt successfully"
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-elasticsearch-rollover-indices:indices": {
"get": {
"tags": [
"Elasticsearch Rollover"
],
"summary": "Get All Rollover Indices",
"description": "Fetches list of indices to be used for rollover and deletion. \n\n**Response Details**\n\n| Attribute | Description |\n|---|---|\n| alias-name | This represents name of the alias used for an index. |\n| is-index-rollover |\tIf true, indicates that rollover and deletion is enabled for the index. Possible Formats: boolean|\n| max-size | The maximum approximate size an index is allowed to be before triggering a rollover. Sizes must use approved byte units. eg. `max-size of 1gb indicates index will be rolled if it reaches 1GB` |\n| max-docs |\tThe maximum number of documents allowed in an index before triggering a rollover. Possible Formats: uint32 eg. `max-docs of 100 indicates index will be rolled if it reaches 100 documents` |\n| max-age | The maximum age that is allowed before triggering a rollover. eg. ages such as 1d for one day, or 30s for 30 seconds can be used. |\n| max-allowed-indices |\tThis represents how old aged indices will be deleted after reaching the given maximum number of allowed indices. Possible Formats: uint8 |",
"operationId": "GetAllRolloverIndices",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 08 May 2020 12:56:52 GMT"
},
"example": "Fri, 08 May 2020 12:56:52 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "6423"
},
"example": "6423"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "private, no-cache"
},
"example": "private, no-cache"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "\"353874a9-75eb-4f5b-b819-8b50fccf79ff\""
},
"example": "\"353874a9-75eb-4f5b-b819-8b50fccf79ff\""
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/GetAllRolloverIndices-Success"
},
"example": {
"indices": {
"index": [
{
"alias-name": "device-configuration-backup",
"is-index-rollover": false,
"delete-conditions": {
"max-allowed-indices": 15
},
"rollover-conditions": {
"max-size": "1gb"
}
},
{
"alias-name": "events-history",
"is-index-rollover": true,
"delete-conditions": {
"max-allowed-indices": 15
},
"rollover-conditions": {
"max-size": "1gb"
}
},
{
"alias-name": "events-latest",
"is-index-rollover": false,
"delete-conditions": {
"max-allowed-indices": 15
},
"rollover-conditions": {
"max-size": "1gb"
}
},
{
"alias-name": "firefly-aaa-accounting",
"is-index-rollover": true,
"delete-conditions": {
"max-allowed-indices": 14
},
"rollover-conditions": {
"max-size": "1gb",
"max-age": "7d"
}
},
{
"alias-name": "job-manager",
"is-index-rollover": true,
"delete-conditions": {
"max-allowed-indices": 15
},
"rollover-conditions": {
"max-size": "1gb"
}
},
{
"alias-name": "job-manager-latest",
"is-index-rollover": true,
"delete-conditions": {
"max-allowed-indices": 15
},
"rollover-conditions": {
"max-size": "1gb"
}
},
{
"alias-name": "mcp-hardware-tracking",
"is-index-rollover": true,
"delete-conditions": {
"max-allowed-indices": 15
},
"rollover-conditions": {
"max-size": "1gb"
}
},
{
"alias-name": "mcp-subscriber-tracking",
"is-index-rollover": true,
"delete-conditions": {
"max-allowed-indices": 15
},
"rollover-conditions": {
"max-size": "1gb"
}
},
{
"alias-name": "object-status-history",
"is-index-rollover": true,
"delete-conditions": {
"max-allowed-indices": 15
},
"rollover-conditions": {
"max-size": "1gb"
}
},
{
"alias-name": "object-status-latest",
"is-index-rollover": false,
"delete-conditions": {
"max-allowed-indices": 15
},
"rollover-conditions": {
"max-size": "1gb"
}
},
{
"alias-name": "script-exec-command",
"is-index-rollover": true,
"delete-conditions": {
"max-allowed-indices": 15
},
"rollover-conditions": {
"max-size": "1gb"
}
},
{
"alias-name": "script-exec-command-latest",
"is-index-rollover": true,
"delete-conditions": {
"max-allowed-indices": 15
},
"rollover-conditions": {
"max-size": "1gb"
}
},
{
"alias-name": "script-exec-log",
"is-index-rollover": true,
"delete-conditions": {
"max-allowed-indices": 15
},
"rollover-conditions": {
"max-size": "1gb"
}
},
{
"alias-name": "upgrade-summary-report",
"is-index-rollover": true,
"delete-conditions": {
"max-allowed-indices": 15
},
"rollover-conditions": {
"max-size": "1gb"
}
},
{
"alias-name": "upgrade-summary-report-latest",
"is-index-rollover": true,
"delete-conditions": {
"max-allowed-indices": 15
},
"rollover-conditions": {
"max-size": "1gb"
}
},
{
"alias-name": "yds-bundle",
"is-index-rollover": true,
"delete-conditions": {
"max-allowed-indices": 15
},
"rollover-conditions": {
"max-size": "1gb"
}
},
{
"alias-name": "yds-bundle-latest",
"is-index-rollover": false,
"delete-conditions": {
"max-allowed-indices": 15
},
"rollover-conditions": {
"max-size": "1gb"
}
},
{
"alias-name": "yds-data-center",
"is-index-rollover": true,
"delete-conditions": {
"max-allowed-indices": 15
},
"rollover-conditions": {
"max-size": "1gb"
}
},
{
"alias-name": "yds-data-center-latest",
"is-index-rollover": false,
"delete-conditions": {
"max-allowed-indices": 15
},
"rollover-conditions": {
"max-size": "1gb"
}
},
{
"alias-name": "yds-device",
"is-index-rollover": true,
"delete-conditions": {
"max-allowed-indices": 15
},
"rollover-conditions": {
"max-size": "1gb"
}
},
{
"alias-name": "yds-device-latest",
"is-index-rollover": false,
"delete-conditions": {
"max-allowed-indices": 15
},
"rollover-conditions": {
"max-size": "1gb"
}
},
{
"alias-name": "yds-interface",
"is-index-rollover": true,
"delete-conditions": {
"max-allowed-indices": 15
},
"rollover-conditions": {
"max-size": "1gb"
}
},
{
"alias-name": "yds-interface-latest",
"is-index-rollover": false,
"delete-conditions": {
"max-allowed-indices": 15
},
"rollover-conditions": {
"max-size": "1gb"
}
},
{
"alias-name": "yds-inventory",
"is-index-rollover": true,
"delete-conditions": {
"max-allowed-indices": 15
},
"rollover-conditions": {
"max-size": "1gb"
}
},
{
"alias-name": "yds-inventory-latest",
"is-index-rollover": false,
"delete-conditions": {
"max-allowed-indices": 15
},
"rollover-conditions": {
"max-size": "1gb"
}
},
{
"alias-name": "yds-job",
"is-index-rollover": true,
"delete-conditions": {
"max-allowed-indices": 15
},
"rollover-conditions": {
"max-size": "1gb"
}
},
{
"alias-name": "yds-job-latest",
"is-index-rollover": false,
"delete-conditions": {
"max-allowed-indices": 15
},
"rollover-conditions": {
"max-size": "1gb"
}
},
{
"alias-name": "yds-label",
"is-index-rollover": true,
"delete-conditions": {
"max-allowed-indices": 15
},
"rollover-conditions": {
"max-size": "1gb"
}
},
{
"alias-name": "yds-label-latest",
"is-index-rollover": false,
"delete-conditions": {
"max-allowed-indices": 15
},
"rollover-conditions": {
"max-size": "1gb"
}
},
{
"alias-name": "yds-management-domain",
"is-index-rollover": true,
"delete-conditions": {
"max-allowed-indices": 15
},
"rollover-conditions": {
"max-size": "1gb"
}
},
{
"alias-name": "yds-management-domain-latest",
"is-index-rollover": false,
"delete-conditions": {
"max-allowed-indices": 15
},
"rollover-conditions": {
"max-size": "1gb"
}
},
{
"alias-name": "yds-profile",
"is-index-rollover": true,
"delete-conditions": {
"max-allowed-indices": 15
},
"rollover-conditions": {
"max-size": "1gb"
}
},
{
"alias-name": "yds-profile-latest",
"is-index-rollover": false,
"delete-conditions": {
"max-allowed-indices": 15
},
"rollover-conditions": {
"max-size": "1gb"
}
},
{
"alias-name": "yds-profile-vector",
"is-index-rollover": true,
"delete-conditions": {
"max-allowed-indices": 15
},
"rollover-conditions": {
"max-size": "1gb"
}
},
{
"alias-name": "yds-profile-vector-latest",
"is-index-rollover": false,
"delete-conditions": {
"max-allowed-indices": 15
},
"rollover-conditions": {
"max-size": "1gb"
}
},
{
"alias-name": "yds-provider",
"is-index-rollover": true,
"delete-conditions": {
"max-allowed-indices": 15
},
"rollover-conditions": {
"max-size": "1gb"
}
},
{
"alias-name": "yds-provider-latest",
"is-index-rollover": false,
"delete-conditions": {
"max-allowed-indices": 15
},
"rollover-conditions": {
"max-size": "1gb"
}
},
{
"alias-name": "yds-server",
"is-index-rollover": true,
"delete-conditions": {
"max-allowed-indices": 15
},
"rollover-conditions": {
"max-size": "1gb"
}
},
{
"alias-name": "yds-server-latest",
"is-index-rollover": false,
"delete-conditions": {
"max-allowed-indices": 15
},
"rollover-conditions": {
"max-size": "1gb"
}
},
{
"alias-name": "yds-service",
"is-index-rollover": true,
"delete-conditions": {
"max-allowed-indices": 15
},
"rollover-conditions": {
"max-size": "1gb"
}
},
{
"alias-name": "yds-service-latest",
"is-index-rollover": false,
"delete-conditions": {
"max-allowed-indices": 15
},
"rollover-conditions": {
"max-size": "1gb"
}
},
{
"alias-name": "yds-yang",
"is-index-rollover": true,
"delete-conditions": {
"max-allowed-indices": 15
},
"rollover-conditions": {
"max-size": "1gb"
}
},
{
"alias-name": "yds-yang-latest",
"is-index-rollover": false,
"delete-conditions": {
"max-allowed-indices": 15
},
"rollover-conditions": {
"max-size": "1gb"
}
}
]
}
}
}
}
}
},
"deprecated": false
}
},
"/operations/adtran-export-data-service:export": {
"post": {
"tags": [
"Export Data"
],
"summary": "Export Interface Inventory",
"description": "Export interface inventory table data from Mosaic Cloud Platform in CSV format. The exported data will be saved to a zip file which can then be used for further processing.\nPossible field values include `interface-name`, `interface-type`, `state`, `interface-id`, `device-name`.\n\n**WARNING** This API is not intended for repeated mass export as it has a high resource usage.\n\n \nRequest Payload Details\n\n\n| Attribute | Description |\n| --- | --- |\n| type | **Required:** The table data to export. Possible Values: audit-logs, events-active, events-historic, device, interface, service |\n| filters | A list of filters to refine search results. Possible Values: field (name of the field), value-list (list of values), exact-match(true/false) |",
"operationId": "ExportInterfaceInventory",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportInterfaceInventoryRequest"
},
"example": {
"input": {
"type": "interface",
"filters": [
{
"field": "interface-type",
"value-list": [
"Generic"
],
"exact-match": false
},
{
"field": "state",
"value-list": [
"activated"
],
"exact-match": false
}
]
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Thu, 17 Dec 2020 21:02:23 GMT"
},
"example": "Thu, 17 Dec 2020 21:02:23 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "346"
},
"example": "346"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"content-disposition": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "attachment; filename=interface-2020-12-17-21-02-22.zip"
},
"example": "attachment; filename=interface-2020-12-17-21-02-22.zip"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
}
},
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"example": ""
},
"example": ""
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-settings:settings": {
"patch": {
"tags": [
"Admin Settings"
],
"summary": "Set Inactivity Logoff Time",
"description": "This API sets the inactivity auto logoff time.\n\n\n| Attribute | Description |\n| --- | --- |\n| inactivity-time-logoff | **Optional:** inactivity-time-logoff: The time in minutes after which the user's session will expire if no API calls are made. A value of 0 means the auto logoff is disabled. Possible values: 0 to 1440 Default value: 30 |",
"operationId": "SetInactivityLogoffTime",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SetInactivityLogoffTimeRequest"
},
"example": {
"settings": {
"user-activity": {
"inactivity-time-logoff": 100
}
}
}
}
},
"required": true
},
"responses": {
"default": {
"description": "",
"headers": {},
"content": {}
},
"400": {
"description": "Bad Request",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 19 Mar 2021 15:03:04 GMT"
},
"example": "Fri, 19 Mar 2021 15:03:04 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
}
},
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/SetInactivityLogoffTime-Failure1"
},
"example": {
"message": "Unrecognized token 'a': was expecting (JSON String, Number, Array, Object or token 'null', 'true' or 'false')\n at [Source: (String)\"{\r\n \"settings\":\r\n {\r\n \"user-activity\":{\"inactivity-time-logoff\":a}\r\n }\r\n}\"; line: 4, column: 56]"
}
}
}
}
},
"deprecated": false
},
"get": {
"tags": [
"Admin Settings"
],
"summary": "Get Inactivity Autologoff Time",
"description": "This API retrieves the inactivity auto logoff time.\nThe response will be in the following format \n{ \n \"settings\": { \n \"credentials\": { \n \"password-visibility\": true \n }, \n \"deferred-intent\": { \n \"enable-deferral\": false \n }, \n \"gfast\": {}, \n \"user-activity\": { \n \"inactivity-time-logoff\": 100 \n } \n } \n} \n\nThe \"inactivity-time-logoff\" attribute shows the time value in minutes",
"operationId": "GetInactivityAutologoffTime",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 19 Mar 2021 14:06:16 GMT"
},
"example": "Fri, 19 Mar 2021 14:06:16 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Vary": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
},
"example": "Accept-Encoding"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "W/\"cd39661a-da7d-44e0-854f-ab8b0868d974\""
},
"example": "W/\"cd39661a-da7d-44e0-854f-ab8b0868d974\""
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "private, no-cache"
},
"example": "private, no-cache"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "gzip"
},
"example": "gzip"
}
}
}
},
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/GetInactivityAutologoffTime-Success"
},
"example": {
"settings": {
"deferred-intent": {
"enable-deferral": false
},
"gfast": {},
"user-activity": {
"inactivity-time-logoff": 100
}
}
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-launchpad-login:login-screen/oidc-provider": {
"get": {
"tags": [
"Single Sign On"
],
"summary": "Get Single Sign On OIDC Provider",
"description": "This API retrieves the Single Sign On OIDC Provider. \nThe response will be in the following format\n\n{\"oidc-provider\":\n\n\\[\n\n{\"name\":\"OktaServerName\",\n\n\"client-id\":\"0oa3t35itpeQzWEyT123\",\n\n\"issuer-uri\":\"https://id-dev.adtran.cloud/oauth2/default\"}\n\n\\]\n\n}\n\nThese values are obtained from the Okta/Single Sign On server under the configured application.",
"operationId": "GetSingleSignOnOIDCProvider",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Sun, 29 May 2022 15:32:29 GMT"
},
"example": "Sun, 29 May 2022 15:32:29 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Vary": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
},
"example": "Accept-Encoding"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "W/\"35fd49aa-8505-41b0-92c4-cc02fdfcc4a4\""
},
"example": "W/\"35fd49aa-8505-41b0-92c4-cc02fdfcc4a4\""
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "private, no-cache"
},
"example": "private, no-cache"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "gzip"
},
"example": "gzip"
}
}
}
},
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/GetSingleSignOnOIDCProvider-Success"
},
"example": {
"oidc-provider": []
}
}
}
}
},
"deprecated": false
},
"patch": {
"tags": [
"Single Sign On"
],
"summary": "Set Single Sign On OIDC Provider",
"description": "This API sets the OIDC provider for Single Sign On (SSO).\n\n| Attribute | Description |\n| --- | --- |\n| name | A placeholder name for the SSO configuration, used to modify or delete the OIDC provider. Not used during runtime. |\n| issuer-uri | Full URL to the external SSO provider. Obtained from the external server. This should not be the admin endpoint. |\n| client-id | The identifier for the client application. Obtained from the external server. |",
"operationId": "SetSingleSignOnOIDCProvider",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SetSingleSignOnOIDCProviderRequest"
},
"example": {
"oidc-provider": [
{
"name": "OktaServer",
"issuer-uri": "https://id-dev.adtran.cloud/oauth2/default",
"client-id": "0oa3t35itpeQzWEyT5d7"
}
]
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Sun, 29 May 2022 15:41:53 GMT"
},
"example": "Sun, 29 May 2022 15:41:53 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "\"ffd58344-e274-44a7-82ab-9972626bc335\""
},
"example": "\"ffd58344-e274-44a7-82ab-9972626bc335\""
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "no-store"
},
"example": "no-store"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
}
},
"content": {}
}
},
"deprecated": false
}
},
"/data/adtran-launchpad-login:login-screen/oidc-provider=OktaServer": {
"delete": {
"tags": [
"Single Sign On"
],
"summary": "Clear Single Sign On OIDC Provider",
"description": "This API deletes the SSO OIDC provider by name in the URL parameter.",
"operationId": "ClearSingleSignOnOIDCProvider",
"parameters": [],
"responses": {
"204": {
"description": "No Content",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Sun, 29 May 2022 15:42:47 GMT"
},
"example": "Sun, 29 May 2022 15:42:47 GMT"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "\"2a52e70e-183b-4a87-a13d-0ab3c96e5332\""
},
"example": "\"2a52e70e-183b-4a87-a13d-0ab3c96e5332\""
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "no-store"
},
"example": "no-store"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
}
},
"content": {}
}
},
"deprecated": false
}
},
"/operations/adtran-cloud-platform-event-workflow:get-events": {
"post": {
"tags": [
"Simple"
],
"summary": "Get All Events",
"description": "The Get Events API can be used for retrieving all the events on the system.\n\n| Attribute | Description |\n|---|---|\n| cursor | **Required**: Cursor position pointing to next request **Possible values**: 0-4294967295.\n| current | Flag to search for historical/current alarms. If current is `true` then search for current (active) alarms. |\n| summary-field | Summary of all alarms based on the field provided. For example, if we provide search filters and provided summary-field as 'severity' and there are 30 matches against the search. Then result is the summary of the search alarms like critical 20 , major 10. **Possible values**-\"severity\" or \"state\".|\n| result-size | Number of records to be returned in a single query. **Possible values**: 0..1000.|\n| include-raw-content | Flag to include raw content in current alarms result set. If include-raw-content is `true` then include raw content in current alarms result set. *See `Filtering` folder requests for examples.* |\n| search-filter-and search-filter-or | Accepts list of search criteria fields which are used to form the boolean queries. For searches included in a `search-filter-and` block, all searches must pass. For searches included in a `search-filter-or`, any search can pass to return a result. See nested fields below can be used to construct search lists under an and/or block. |\n| search-filter-and search-filter-or
search-field
| Accepts list of search criteria fields which are used to form the boolean queries **Possible values** \\* **severity**: Sorts events on severity with `search-value` as `critical`, `major`, `minor`, `info`, `cleared`, `warning` \\* **source**: Allows retrieval of event data from different sources.The source of the event e.g. a device, interface etc. eg. `mosaic-cp-cda` \\* **identity**: Sorts events on event-identity.The identity of the event such as thermal-shutdown-alarm,high-temp-alarm. \\* **object-name**: Associated object name of event \\* **object-type**: Associated object type of event on Mosaic CP \\* **description**: The brief description of the event. |\n| search-filter-and search-filter-or
search-action
| Used to determine the type of the search action. **Possible values** \\* **include-strict**: Used to search for fields with exact matching of the given value. \\* **include-regex** Used to search for fields with includes the value with given regex matching. \\* **exclude-strict**: Used to exclude the given fields with the given value with exact matching. \\* **exclude-regex**: Used to exclude the given fields with the given value with regex matching. \\* **gte**: Used to indicate the filtering timestamp value greater or equal to the given value. \\* **lte**: Used to indicate the filtering timestamp value smaller or equal to the given value. |\n| search-filter-and search-filter-or
search-value
| String value on which to search. The format of this fields depends on the `search-field` and `search-action`. For time based values, the following format is used: **Date Time Format**: yyyy-MM-dd'T'HH:mm:ss.ff'Z' eg. `2020-05-02T18:30:00Z` |\n| sort-by | Used to determine the sequencing of events. **Possible values** \\***source**: Sorts events on event source \\***identity**: Sorts events on event identity \\***severity**: Sorts events on event severity. Examples: `critical`, `major`, `minor`, `alert`, `info`, and `clear`. \\***timestamp**: Sorts events on event time. \\***raised-timestamp**: Sorts events on when they were raised. \\***cleared-timestamp**: Sorts events on when they were cleared. *See `Sorting` folder requests for examples.* |\n| order-by | Orders the events in the given order for the `sort-by` field. If no sort-by value is provided, then timestamp is used for ordering. **Possible values** \\***asc**: Order by ascending values \\***desc**: Order by descending values *See `Sorting` folder requests for examples.* |\n\n\n The following filtering fields are deprecated in favor of using the `search-field`/`search-action` fields above. \n\n| Attribute | Description |\n|---|---|\n| source | Return all events matching the source specified. If no source is provided, return events from all sources. |\n| exact-match | Flag to indicate whether to use fuzzy search or exact search. Value of true indicates exact match of search and false indicates fuzzy search. |\n| from-time | Filter all events starting from 'from-time'. If not present, query result will contain oldest available events until to-time **Date Time Format**: yyyy-MM-dd'T'HH:mm:ss.ff'Z' eg. `2020-05-02T18:30:00Z`. |\n| to-time | Filter all events until 'to-time'. If not present, query result will contain latest available events starting from from-time **Date Time Format**: yyyy-MM-dd'T'HH:mm:ss.ff'Z' eg. `2020-05-02T22:30:00Z`. *See `Filtering` folder requests for examples.* |",
"operationId": "GetAllEvents",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetAllEventsRequest"
},
"example": {
"input": {
"summary-field": "severity",
"current": false,
"cursor": 0,
"result-size": 2
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Thu, 07 Jan 2021 20:05:47 GMT"
},
"example": "Thu, 07 Jan 2021 20:05:47 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Vary": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
},
"example": "Accept-Encoding"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "gzip"
},
"example": "gzip"
}
}
}
},
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/GetAllEvents"
},
"example": {
"output": {
"events": {
"cursor": 2,
"event": [
{
"description": "Validation failed of action activate device dpu-0001. Action 'activate' not allowed for dpu-0001 with state 'activated'",
"event-identity": "activate dpu-0001",
"object-name": "dpu-0001",
"object-type": "device",
"raised-timestamp": "2021-01-07T19:41:36+00:00",
"severity": "Informational",
"source": "mosaic-cp-cda",
"timestamp": "2021/01/07 07:41:36PM+0000",
"timestamp-iso": "2021-01-07T19:41:36+00:00"
},
{
"description": "Failed action of deactivate device dpu-0001. Master timeout reached",
"event-identity": "deactivate dpu-0001",
"object-name": "dpu-0001",
"object-type": "device",
"raised-timestamp": "2021-01-07T19:41:36+00:00",
"severity": "Major",
"source": "mosaic-cp-cda",
"timestamp": "2021/01/07 07:41:36PM+0000",
"timestamp-iso": "2021-01-07T19:41:36+00:00"
}
],
"total-count": 18709
}
}
}
}
}
}
},
"deprecated": false
}
},
"/operations/adtran-cloud-platform-topics:create-topic": {
"post": {
"tags": [
"Kafka Event Forwarding"
],
"summary": "Create Topic",
"description": "Creates a Kafka topic which is accessible by a given user and contains the specified types of events. Topics can be consumed from Mosaic Cloud using a Kafka consumer. Once configured, Mosaic Cloud will automatically push events to the consumer.\n
**Note**: There is a need to configure the authentication of the external Kafka consumer. See the Mosaic CP Installation Guide for more details on how to configure an external Kakfa consumer with the appropriate encyrption to receive events.\n\n| Attribute | Description |\n|---|---|\n| topic-name | The user-defined name of the Kafka topic that will be exposed externally on Mosaic CP.|\n| username | The user which is authorized to consume this topic. Such user have the permission `adtran-cloud-platform-topics:configure-topics` to their respective user group |\n| contains | This represents the comma separated list. For example, to get notifications for when a Mosaic CP object finishes transitioning to another state, use `uiworkflow-transition-complete` here. To see a comprehensive list of available event types to subscribe to on an instance of Mosaic CP, check the response back from the `Get Event Types` request below. |",
"operationId": "CreateTopic",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateTopicRequest"
},
"example": {
"input": {
"topic-name": "mosaic-stream",
"username": "SampleUser",
"contains": [
"uiworkflow-transition-complete"
]
}
}
}
},
"required": true
},
"responses": {
"409": {
"description": "Conflict",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Wed, 06 May 2020 10:49:14 GMT"
},
"example": "Wed, 06 May 2020 10:49:14 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "50"
},
"example": "50"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/TopicAlreadyCreated-409Conflict1"
},
"example": {
"message": "mosaic-stream topic already created."
}
}
}
},
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Wed, 06 May 2020 10:42:47 GMT"
},
"example": "Wed, 06 May 2020 10:42:47 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "0"
},
"example": "0"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {}
}
},
"deprecated": false
}
},
"/operations/adtran-cloud-platform-topics:update-topic": {
"post": {
"tags": [
"Kafka Event Forwarding"
],
"summary": "Update Topic",
"description": "Update a topic that already exists. This can be used to add or remove event types from the list.\n\n| Attribute | Description |\n|---|---|\n| topic-name | The user-defined name of the Kafka topic that will be exposed externally on Mosaic CP. |\n| username | The user which is authorized to consume this topic. Such user have the permission `adtran-cloud-platform-topics:configure-topics` to their respective user group |\n| contains | This represents the comma separated list. For example, to get notifications for when a Mosaic CP object finishes transitioning to another state, use `uiworkflow-transition-complete` here. To see a comprehensive list of available event types to subscribe to on an instance of Mosaic CP, check the response back from the `Get Event Types` request below. |",
"operationId": "UpdateTopic",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateTopicRequest"
},
"example": {
"input": {
"topic-name": "mosaic-stream",
"username": "SampleUser",
"contains": [
"onu-los",
"NETCONF-session-disconnect"
]
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Thu, 07 May 2020 10:19:24 GMT"
},
"example": "Thu, 07 May 2020 10:19:24 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "0"
},
"example": "0"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-topics:event-types": {
"get": {
"tags": [
"Kafka Event Forwarding"
],
"summary": "Get Event Types",
"description": "Get Topic Event API will allow an upstream system to determine the supported events for forwarding through the Kafka interface.\n\n**Response Details**\n\n| Attribute| Description |\n|---|---|\n| event-type | Provides a list of event types supported by this system which may be used to configure topics.\n| event-type-name | The name of an event-type which is supported by this system.|",
"operationId": "GetEventTypes",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Wed, 06 May 2020 09:50:32 GMT"
},
"example": "Wed, 06 May 2020 09:50:32 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "788"
},
"example": "788"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/GetEventTypes"
},
"example": {
"adtran-cloud-platform-topics:event-types": {
"event-type": [
{
"event-type-name": "uiworkflow-transition-complete"
},
{
"event-type-name": "channel-pair-wavelength-mismatch"
},
{
"event-type-name": "channel-partition-los"
},
{
"event-type-name": "netconf-session-events"
},
{
"event-type-name": "olt-hardware-alarms"
},
{
"event-type-name": "olt-high-temp-alarms"
},
{
"event-type-name": "olt-low-temp-alarms"
},
{
"event-type-name": "olt-optical-threshold-alarms"
},
{
"event-type-name": "olt-pluggable-alarms"
},
{
"event-type-name": "olt-power-reduction-alarms"
},
{
"event-type-name": "olt-thermal-shutdown-alarms"
},
{
"event-type-name": "olt-unapproved-transceiver-alarms"
},
{
"event-type-name": "onu-activate"
},
{
"event-type-name": "onu-dying-gasp"
},
{
"event-type-name": "onu-los"
},
{
"event-type-name": "onu-range-adjustment-complete"
}
]
}
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-topics:topics/topic": {
"get": {
"tags": [
"Kafka Event Forwarding"
],
"summary": "Get All Created Topics",
"description": "Get Topic Event API will allow an upstream system to automatically determine the supported events for forwarding through the Kafka interface.\nThe following table describes each item in the response.\n\n| Attribute | Description |\n|---|---|\n| topic-name | The user-defined name of the Kafka topic that will be exposed externally on Mosaic CP.|\n| username | The user which is authorized to consume this topic. Such user have the permission `adtran-cloud-platform-topics:configure-topics` to their respective user group |\n| contains | This represents the comma separated list. For example, to get notifications for when a Mosaic CP object finishes transitioning to another state, use `uiworkflow-transition-complete` here. To see a comprehensive list of available event types to subscribe to on an instance of Mosaic CP, check the response back from the `Get Event Types` request. |",
"operationId": "GetAllCreatedTopics",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Wed, 06 May 2020 12:51:02 GMT"
},
"example": "Wed, 06 May 2020 12:51:02 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "723"
},
"example": "723"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "private, no-cache"
},
"example": "private, no-cache"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "\"90ce33c0-58ac-4d4a-9bb1-a800e455fc8e\""
},
"example": "\"90ce33c0-58ac-4d4a-9bb1-a800e455fc8e\""
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/GetAllCreatedTopics"
},
"example": {
"topic": [
{
"username": "ADMIN",
"topic-name": "mosaic-stream",
"contains": [
"device-unit-install-in-progress",
"PM-FORWARDING"
]
},
{
"username": "ADMIN",
"topic-name": "mosaic-stream1",
"contains": [
"PM_FORWARDING"
]
},
{
"username": "ADMIN",
"topic-name": "testkafka-topic",
"contains": [
"olt-optical-threshold-alarms",
"olt-high-temp-alarms",
"olt-pluggable-alarms",
"olt-unapproved-transceiver-alarms",
"olt-hardware-alarms",
"olt-power-reduction-alarms",
"olt-thermal-shutdown-alarms",
"olt-low-temp-alarms",
"channel-pair-wavelength-mismatch",
"channel-partition-los",
"onu-range-adjustment-complete",
"onu-dying-gasp",
"onu-los",
"onu-activate"
]
},
{
"username": "ADMIN",
"topic-name": "uiworkflow-event-topic",
"contains": [
"uiworkflow-transition-complete"
]
}
]
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-trap-forwarder:trap-forwarder/trap-hosts": {
"post": {
"tags": [
"Configure Trap Host"
],
"summary": "SNMP v2c - Specific Filter",
"description": "The command is used to configure a single trap host at a time within the system.\n\n| Attribute | Description |\n|---|---|\n| Host | **Required** IPv4 address, IPv6 address or domain name of the host. |\n| Port | **Required** Port number on which the trap host will receive traps. |\n|any-source | Used to indicates the filter matches on any source. Possible Values : [null] |\n|source | Used to specify what filter to place on the source of the received trap.|\n|any-identity | Used to indicates the filter matches on any identity. Possible Values : [null] |\n|identity | Used to specify what filter to place on the identity of the received trap.|\n|any-severity | Used to indicates the filter matches on any severity. Possible Values : [null] |\n|trap-severity |Used to specify what filter to place on the severity of the received trap. Possible Values : critical, major, minor, clear, alert, info|\n|filter-action | Used to determine the action taken if the trap source matches the source filter. Possible Values : permit, deny Permit a trap if certain aspects of the trap match the the specified filter. Note that other filters may still cause the trap to be denied. Deny a trap if certain aspects of the trap match the specified filter.|",
"operationId": "SNMPv2c-SpecificFilter",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SNMPv2c-SpecificFilterRequest"
},
"example": {
"host": "127.0.0.1",
"port": 162,
"identity": {
"identity": [
"OLT-1"
],
"filter-action": "permit"
},
"trap-severity": {
"severity": [
"critical"
],
"filter-action": "permit"
},
"source": {
"source": [
"127.0.0.1"
],
"filter-action": "permit"
}
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Thu, 25 Jun 2020 08:37:11 GMT"
},
"example": "Thu, 25 Jun 2020 08:37:11 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {}
},
"409": {
"description": "Conflict",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Thu, 25 Jun 2020 08:37:36 GMT"
},
"example": "Thu, 25 Jun 2020 08:37:36 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json;charset=utf-8": {
"schema": {
"type": "string",
"example": "Trap-host with provided hostname and port already exists.Please modify it."
},
"example": "Trap-host with provided hostname and port already exists.Please modify it."
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Thu, 25 Jun 2020 08:39:28 GMT"
},
"example": "Thu, 25 Jun 2020 08:39:28 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json;charset=utf-8": {
"schema": {
"type": "string",
"example": "Invalid Port provided"
},
"example": "Invalid Port provided"
}
}
}
},
"deprecated": false
},
"get": {
"tags": [
"SNMP Trap Forwarding"
],
"summary": "Retrieve All Trap Hosts",
"description": "This command is used to retrieve a list of the trap hosts that have been configured on the system for translating and sending to an upstream alarm collection system.\n\n|Response Attribute | Description|\n|---|---|\n Host | IPv4 address, IPv6 address or domain name of the host. |\n| Port | Port number on which the trap host will receive traps. |\n|use-global-filter |If true, indicates the global filter is to be used. |\n|source | Used to specify what filter to place on the source of the received trap.|\n|identity | Used to specify what filter to place on the identity of the received trap.|\n|trap-severity |Used to specify what filter to place on the severity of the received trap. Possible Values: critical, major, minor, clear, alert, info|\n|filter-action | Used to determine the action taken if the trap source matches the source filter. Possible Values: permit, deny Permit a trap if certain aspects of the trap match the the specified filter. Note that other filters may still cause the trap to be denied. Deny a trap if certain aspects of the trap match the specified filter.|",
"operationId": "RetrieveAllTrapHosts",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Thu, 07 May 2020 08:18:37 GMT"
},
"example": "Thu, 07 May 2020 08:18:37 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "277"
},
"example": "277"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RetrieveAllTrapHosts-4hostsspecificfilterandglobalfilter"
},
"description": ""
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-trap-forwarder:trap-forwarder/trap-hosts/trap-host=127.0.0.1,162": {
"get": {
"tags": [
"SNMP Trap Forwarding"
],
"summary": "Retrieve Specific Trap Host",
"description": "This command is used to retrieve a Specific trap hosts that have been configured on the system for translating and sending to an upstream alarm collection system.\n\n \nURL Request query parameter details - \n \n\n| Attribute | Description |\n| --- | --- |\n| trap-host | **Required** Comma separated value for the `ip-address`,`port` of the trap-host. |\n\nResponse body details -\n \n\n|Response Attribute | Description|\n|---|---|\n| Host | IPv4 address, IPv6 address or domain name of the host. |\n| Port | Port number on which the trap host will receive traps. |\n|use-global-filter |If true, indicates the global filter is to be used. |\n|source | Used to specify what filter to place on the source of the received trap.|\n|identity | Used to specify what filter to place on the identity of the received trap.|\n|trap-severity |Used to specify what filter to place on the severity of the received trap. Possible Values: critical, major, minor, clear, alert, info|\n|filter-action | Used to determine the action taken if the trap source matches the source filter. Possible Values: permit, deny Permit a trap if certain aspects of the trap match the the specified filter. Note that other filters may still cause the trap to be denied. Deny a trap if certain aspects of the trap match the specified filter.|",
"operationId": "RetrieveSpecificTrapHost",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Thu, 07 May 2020 08:31:34 GMT"
},
"example": "Thu, 07 May 2020 08:31:34 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "58"
},
"example": "58"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/RetrieveSpecificTrapHost-GlobalFilter-Successful"
},
"example": {
"host": "127.0.0.1",
"port": 162,
"source": {
"source": [
"127.0.0.1"
],
"filter-action": "permit"
},
"trap-severity": {
"severity": [
"critical"
],
"filter-action": "permit"
},
"identity": {
"identity": [
"OLT-1"
],
"filter-action": "permit"
}
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Thu, 07 May 2020 08:17:10 GMT"
},
"example": "Thu, 07 May 2020 08:17:10 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "52"
},
"example": "52"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"type": "string",
"example": "No trap-host with provided host name and port exists"
},
"example": "No trap-host with provided host name and port exists"
}
}
}
},
"deprecated": false
},
"put": {
"tags": [
"SNMP Trap Forwarding"
],
"summary": "Modify Trap Host",
"description": "The format of this command includes IP Address and IP PORT to identify and modify the request. A comma separates the IP Address from the Port value.\n\n\n| Attribute | Description |\n|---|---|\n| Host | **Required** IPv4 address, IPv6 address or domain name of the host. |\n| Port | **Required** Port number on which the trap host will receive traps. |\n| version | Used to specify which version is supported at trap-host Possible Values: snmp-v2c or snmp-v3|\n| use-global-filter | Used to specify any filters to apply to the received traps. If present, indicates the global filter is to be used. Possible Values: [null]|\n|specific-filter| Management objects used to specify a trap filter.|\n|any-source | Used to indicates the filter matches on any source. Possible Values: [null] |\n|source | Used to specify what filter to place on the source of the received trap.|\n|any-identity | Used to indicates the filter matches on any identity. Possible Values: [null] |\n|identity | Used to specify what filter to place on the identity of the received trap.|\n|any-severity | Used to indicates the filter matches on any severity. Possible Values: [null] |\n|trap-severity | Used to specify what filter to place on the severity of the received trap. Possible Values: critical, major, minor, clear, alert, info|\n|filter-action | Used to determine the action taken if the trap source matches the source filter. Possible Values: permit, deny Permit a trap if certain aspects of the trap match the the specified filter. Note that other filters may still cause the trap to be denied. Deny a trap if certain aspects of the trap match the specified filter.|",
"operationId": "ModifyTrapHost",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModifyTrapHostRequest"
},
"example": {
"host": "127.0.0.1",
"port": 162,
"identity": {
"identity": [
"OLT-1"
],
"filter-action": "permit"
},
"trap-severity": {
"severity": [
"critical"
],
"filter-action": "permit"
},
"source": {
"source": [
"127.0.0.1"
],
"filter-action": "permit"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Thu, 07 May 2020 11:40:34 GMT"
},
"example": "Thu, 07 May 2020 11:40:34 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "0"
},
"example": "0"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {}
},
"default": {
"description": "",
"headers": {},
"content": {}
}
},
"deprecated": false
},
"delete": {
"tags": [
"SNMP Trap Forwarding"
],
"summary": "Delete Trap Host",
"description": "Removes a previously created SNMP Trap Host.\n\n \nURL Request query parameter details - \n \n\n| Attribute | Description |\n| --- | --- |\n| trap-host | **Required** Comma separated value for the `ip-address`,`port` of the trap-host. |",
"operationId": "DeleteTrapHost",
"parameters": [],
"responses": {
"404": {
"description": "Not Found",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Thu, 07 May 2020 08:15:58 GMT"
},
"example": "Thu, 07 May 2020 08:15:58 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "51"
},
"example": "51"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"type": "string",
"example": "No Trap-host with hostname and port provided exists"
},
"example": "No Trap-host with hostname and port provided exists"
}
}
},
"204": {
"description": "No Content",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Thu, 07 May 2020 08:15:29 GMT"
},
"example": "Thu, 07 May 2020 08:15:29 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "0"
},
"example": "0"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {}
}
},
"deprecated": false
}
},
"/data/adtran-trap-forwarder:trap-forwarder/global-filter": {
"get": {
"tags": [
"SNMP Trap Forwarding"
],
"summary": "Retrieve Global Filter",
"description": "Specifies a global (or default) filter to be used for each trap host.\n\n|Response Attribute | Description|\n|---|---|\n|any-source | Used to indicates the filter matches on any source. Possible Values : [null] |\n|source | Used to specify what filter to place on the source of the received trap.|\n|any-identity | Used to indicates the filter matches on any identity. Possible Values : [null] |\n|identity | Used to specify what filter to place on the identity of the received trap.|\n|any-severity | Used to indicates the filter matches on any severity. Possible Values : [null] |\n|trap-severity |Used to specify what filter to place on the severity of the received trap. Possible Values : critical, major, minor, clear, alert, info|\n|filter-action | Used to determine the action taken if the trap source matches the source filter. Possible Values : permit, deny Permit a trap if certain aspects of the trap match the the specified filter. Note that other filters may still cause the trap to be denied. Deny a trap if certain aspects of the trap match the specified filter.|",
"operationId": "RetrieveGlobalFilter",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Thu, 07 Jan 2021 20:20:47 GMT"
},
"example": "Thu, 07 Jan 2021 20:20:47 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Vary": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
},
"example": "Accept-Encoding"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "gzip"
},
"example": "gzip"
}
}
}
},
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/RetrieveGlobalFilter"
}
}
}
}
},
"deprecated": false
},
"put": {
"tags": [
"SNMP Trap Forwarding"
],
"summary": "Modify Global Filter",
"description": "This command is used to modify a global (or default) filter to be used for each trap host.\n\n|Attribute| Description|\n|---|---|\n|any-source | Used to indicates the filter matches on any source. Possible Values: [null] |\n|source | Used to specify what filter to place on the source of the received trap.|\n|any-identity | Used to indicates the filter matches on any identity. Possible Values: [null] |\n|identity | Used to specify what filter to place on the identity of the received trap.|\n|any-severity | Used to indicates the filter matches on any severity. Possible Values: [null] |\n|trap-severity |Used to specify what filter to place on the severity of the received trap. Possible Values: critical, major, minor, clear, alert, info|\n|filter-action | Used to determine the action taken if the trap source matches the source filter. Possible Values: permit, deny Permit a trap if certain aspects of the trap match the the specified filter. Note that other filters may still cause the trap to be denied. Deny a trap if certain aspects of the trap match the specified filter.|",
"operationId": "ModifyGlobalFilter",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModifyGlobalFilterRequest"
},
"example": {
"identity": {
"identity": [
"OLT-1"
],
"filter-action": "permit"
},
"trap-severity": {
"severity": [
"critical"
],
"filter-action": "permit"
},
"source": {
"source": [
"127.0.0.1"
],
"filter-action": "permit"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 08 May 2020 08:03:23 GMT"
},
"example": "Fri, 08 May 2020 08:03:23 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "0"
},
"example": "0"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {}
},
"default": {
"description": "",
"headers": {},
"content": {}
}
},
"deprecated": false
}
},
"/data/adtran-trap-forwarder:trap-forwarder/trap-forwarder-state": {
"get": {
"tags": [
"SNMP Trap Forwarding"
],
"summary": "Retrieve Trap Forwarder State",
"description": "This command provides information of the trap forwarding state.\n\n|Response Attribute | Description|\n|---|---|\n engine-id | Provides the SNMP engine-id of the current active node that will be sent with SNMPv3 traps. By default, this is assigned automatically at system startup. The default id can be overridden in the user.conf file with `engine-id = \\\"1234567890abcdef\\\"` which would represent an engine-id of `12:34:56:78:90:ab:cd:ef`|",
"operationId": "RetrieveTrapForwarderState",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 23 Jun 2020 09:06:46 GMT"
},
"example": "Tue, 23 Jun 2020 09:06:46 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Vary": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
},
"example": "Accept-Encoding"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "gzip"
},
"example": "gzip"
}
}
}
},
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/RetrieveTrapForwarderStatei.eengine-id"
},
"example": {
"engine-id": "80:00:13:70:01:c0:a8:01:08:58:1c:8c:29"
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-latest-events:latest-events/latest-event=SDXOne": {
"get": {
"tags": [
"Event Correlation"
],
"summary": "Get Latest Event",
"description": "Fetches information about the last event processed for a given session.\n\n| **Attribute** | **Description** |\n| --- | --- |\n| session-name | The name of the session that generated the event(s). |\n| timestamp | The timestamp of the latest event processed for this session. **Date Time Format**: yyyy-MM-dd'T'HH:mm:ss.ff'Z' eg. 2020-05-02T18:30:00Z |",
"operationId": "GetLatestEvent",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"enum": [
"application/json"
],
"type": "string",
"example": "application/json"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Thu, 17 Mar 2022 19:14:06 GMT"
},
"example": "Thu, 17 Mar 2022 19:14:06 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Vary": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
},
"example": "Accept-Encoding"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "gzip"
},
"example": "gzip"
}
}
}
},
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/GetLatestEvent-Success"
},
"example": {
"session-name": "SampleSessionName",
"timestamp": "2022-01-01T00:00:00.015Z"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Thu, 17 Mar 2022 19:14:06 GMT"
},
"example": "Thu, 17 Mar 2022 19:14:06 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Vary": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
},
"example": "Accept-Encoding"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "gzip"
},
"example": "gzip"
}
}
}
},
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/GetLatestEvent-Sessionnotfound1"
},
"example": {
"message": "event-session-name BadSessionName was not found"
}
}
}
},
"503": {
"description": "Service Unavailable",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Thu, 17 Mar 2022 19:14:06 GMT"
},
"example": "Thu, 17 Mar 2022 19:14:06 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Vary": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
},
"example": "Accept-Encoding"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "gzip"
},
"example": "gzip"
}
}
},
"Retry-After": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "10"
},
"example": "10"
}
}
}
},
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/GetLatestEvent-Storagenotready1"
},
"example": {
"message": "the cache is not yet ready to provide a response"
}
}
}
}
},
"deprecated": false
}
},
"/operations/adtran-cloud-platform-latest-events:delete-events-entry": {
"post": {
"tags": [
"Event Correlation"
],
"summary": "Delete Latest Event",
"description": "Delete a latest event time session entry by supplying the session name. This does not delete the event, just the entry tracking the last processed event's timestamp.\n\n| **Attribute** | **Description** |\n| --- | --- |\n| event-session-name | The name of the session to delete. |",
"operationId": "DeleteLatestEvent",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteLatestEventRequest"
},
"example": {
"input": {
"event-session-name": "SDXOne"
}
}
}
},
"required": true
},
"responses": {
"204": {
"description": "No Content",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Thu, 17 Mar 2022 19:26:19 GMT"
},
"example": "Thu, 17 Mar 2022 19:26:19 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Vary": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
},
"example": "Accept-Encoding"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "gzip"
},
"example": "gzip"
}
}
}
},
"content": {}
},
"404": {
"description": "Not Found",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Thu, 17 Mar 2022 19:26:19 GMT"
},
"example": "Thu, 17 Mar 2022 19:26:19 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Vary": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
},
"example": "Accept-Encoding"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "gzip"
},
"example": "gzip"
}
}
}
},
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/DeleteLatestEvent-Sessionnotfound1"
},
"example": {
"message": "event-session-name BadSessionName was not found"
}
}
}
},
"503": {
"description": "Service Unavailable",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Thu, 17 Mar 2022 19:26:19 GMT"
},
"example": "Thu, 17 Mar 2022 19:26:19 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Vary": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
},
"example": "Accept-Encoding"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "gzip"
},
"example": "gzip"
}
}
}
},
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/DeleteLatestEvent-Sessionnotready1"
},
"example": {
"message": "the cache is not yet ready to provide a response"
}
}
}
}
},
"deprecated": false
}
},
"/operations/adtran-cloud-platform-uiworkflow:create": {
"post": {
"tags": [
"Backup Device Configuration"
],
"summary": "Create Job- Backup Device Configuration",
"description": "The parameters required to `configure` a Backup job.\n\n| Attribute | Description |\n|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| job-name | **Required:** Name of the Job |\n| action | **Required:** The action that the job will run. For a list of actions your server supports, run the `Get All Job Actions` request. |\n| trigger | **Required:** The trigger that will cause the job to run. Possible values: On Activate: This will trigger the job on Activate operation Date-Time: This will trigger the job at a particular Date and time specified during Deploy operation|",
"operationId": "CreateJob-BackupDeviceConfiguration",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateJob-BackupDeviceConfigurationRequest"
},
"example": {
"input": {
"job-context": {
"job-name": "Backup Device Configuration Job",
"action": "Backup Device Configuration",
"trigger": "On Activate"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 08 May 2020 14:44:25 GMT"
},
"example": "Fri, 08 May 2020 14:44:25 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "205"
},
"example": "205"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/JobCreate-BackupDeviceConfiguration"
},
"example": {
"output": {
"timestamp": "2020-05-08T14:44:25.588000",
"job-name": "Backup Device Configuration Job",
"status": "configuring",
"trans-id": "0baef8e1-dce1-4165-b7a2-272470f55d68",
"completion-status": "in-progress"
}
}
}
}
}
},
"deprecated": false
}
},
"/operations/adtran-cloud-platform-uiworkflow:deploy": {
"post": {
"tags": [
"Backup Device Configuration"
],
"summary": "Deploy Job- Backup Device Configuration",
"description": "The parameters required to `deploy` a Backup job.\n\n| Attribute | Description |\n|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| job-name | **Required:** Name of the Job |\n| name | **Required:** The name of the context parameter. |\n| type | **Required:** A hint to the type of information that is represented in this field of context. This may be used by a User Interface to create a list of suitable values from which to select. |\n| subtype | **Required:** A list of strings that provide more information about the acceptable values for this context element. The meaning depends on the type. For example, if type is 'device', this is a list of acceptable model names. If type is 'list', this is the list of possible values. |\n| hint | **Required:** A textual short description of applicable values and its unit of measure. |\n| value or value-list | **Required:** Defines the value of the context parameter as a single string or a list of string. This can be \"\" or [] if filter-list is used. |\n| filter-list | **Required:** The filter-criteria that will used for filtering the objects. It support below filter-criteria and anyone of them need to proviaded. Possible Values: By Label: Enter the label(s) used to select devices; these will be evaluated together as a logic OR. By Management Domain: Enter Management domain(s) used to select devices; these will be evaluated together as a logic OR. By Parent Device: Enter parent device(s) used to select children devices. By Name: Enter the device name(s) used to select devices |\n| trigger-context | **Required:** The context parameters required for this job trigger. Possible Values: trigger: \"On Activate\" then it will be empty list. trigger: \"Date-Time\" then type: \"cron-expression\" name: \"cron-expression\" value: Uses the quartz cron scheduler. Cron expression format defined at http://www.quartz-scheduler.org. eg. 0 40 4 9 5 ? 2020 which specifies \"At 04:40:00am, on the 9th day, in May, in 2020\" hint: \"The desired cron expression for triggering the job firing schedule\" |",
"operationId": "DeployJob-BackupDeviceConfiguration",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeployJob-BackupDeviceConfigurationRequest"
},
"example": {
"input": {
"job-context": {
"job-name": "Backup Device Configuration Job",
"action-context": [
{
"name": "Filter Criteria",
"type": "device",
"filter-list": [
{
"name": "By Label",
"type": "label",
"hint": "Enter the label(s) used to select devices; these will be evaluated together as a logic OR.",
"value-list": [],
"filter-criteria": "by-label"
},
{
"name": "By Management Domain",
"type": "management-domain",
"hint": "Enter Management domain(s) used to select devices; these will be evaluated together as a logic OR.",
"value-list": [],
"filter-criteria": "by-management-domain"
},
{
"name": "By Parent Device",
"type": "device",
"hint": "Enter parent device(s) used to select children devices.",
"value-list": [],
"filter-criteria": "by-parent-device"
},
{
"name": "By Name",
"type": "device",
"hint": "Enter the device name(s) used to select devices",
"value-list": [
"device-1"
],
"filter-criteria": "by-name"
}
],
"hint": "Choose how you would like to select the devices that would be affected by this job.",
"value-list": []
}
],
"trigger-context": []
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 08 May 2020 14:45:13 GMT"
},
"example": "Fri, 08 May 2020 14:45:13 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "203"
},
"example": "203"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/JobDeploy-BackupDeviceConfiguration"
},
"example": {
"output": {
"timestamp": "2020-05-08T14:45:13.034000",
"job-name": "Backup Device Configuration Job",
"status": "deploying",
"trans-id": "7da3716c-4602-4006-a48c-e3507307cd0c",
"completion-status": "in-progress"
}
}
}
}
}
},
"deprecated": false
}
},
"/operations/adtran-cloud-platform-uiworkflow:activate": {
"post": {
"tags": [
"Backup Device Configuration"
],
"summary": "Activate Job- Backup Device Configuration",
"description": "The parameters required to `activate` a Backup job.\n\n| Attribute | Description |\n|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| job-name | **Required:** Name of the Job which need to be activated |",
"operationId": "ActivateJob-BackupDeviceConfiguration",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActivateJob-BackupDeviceConfigurationRequest"
},
"example": {
"input": {
"job-context": {
"job-name": "Backup Device Configuration Job"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 08 May 2020 14:45:26 GMT"
},
"example": "Fri, 08 May 2020 14:45:26 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "204"
},
"example": "204"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/JobActivate-BackupDeviceConfiguration"
},
"example": {
"output": {
"timestamp": "2020-05-08T14:45:26.096000",
"job-name": "Backup Device Configuration Job",
"status": "activating",
"trans-id": "f3a475c0-1c45-48b9-8abe-3e6f4da28864",
"completion-status": "in-progress"
}
}
}
}
}
},
"deprecated": false
}
},
"/operations/adtran-cloud-platform-uiworkflow-jobs:run-job-now": {
"post": {
"tags": [
"Backup Device Configuration"
],
"summary": "Run Job- Backup Device Configuration",
"description": "This API is to run a job immediately with the current context.\n\n| Attribute | Description |\n|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| job-name | **Required:** Name of the Job |",
"operationId": "RunJob-BackupDeviceConfiguration",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunJob-BackupDeviceConfigurationRequest"
},
"example": {
"input": {
"job-name": "Backup Device Configuration Job"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 08 May 2020 14:45:56 GMT"
},
"example": "Fri, 08 May 2020 14:45:56 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "237"
},
"example": "237"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/JobRun-BackupDeviceConfiguration"
},
"example": {
"output": {
"trans-id": "9a1cbbbd-a75d-4b98-947c-e4e994f15624",
"completion-status": "in-progress"
}
}
}
}
},
"default": {
"description": "",
"headers": {},
"content": {}
}
},
"deprecated": false
}
},
"/operations/adtran-cloud-platform-uiworkflow-jobs:run-job-now-with-parameters": {
"post": {
"tags": [
"Download, Activate and Commit Jobs"
],
"summary": "Run Job - Download Job",
"description": "This API is to run a job immediately with the updated context. To run this API, Job must be in `Deployed` state\n\n| Attribute | Description |\n|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| job-name | **Required:** Name of the Job |\n| blocking | **Required:** Denotes whether or not the call is blocking. A blocking call will not return until the job has completed running. A non-blocking call will return immediately; its status can be verified with run-job-transitions. **Possible Value: true** |\n| name | **Required:** The name of the context parameter. |\n| type | A hint to the type of information that is represented in this field of context. This may be used by a User Interface to create a list of suitable values from which to select. |\n| hint | A textual short description of applicable values and its unit of measure. |\n| value or value-list | **Required:** Defines the value of the context parameter as a single string or a list of string. |",
"operationId": "RunJob-DownloadJob",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunJob-DownloadJobRequest"
},
"example": {
"input": {
"job-name": "Download Job",
"blocking": true,
"context": [
{
"name": "Device Name",
"value-list": [
"device-1"
]
}
]
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 08 May 2020 12:37:20 GMT"
},
"example": "Fri, 08 May 2020 12:37:20 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "289"
},
"example": "289"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JobRun-ActivateDeviceSoftwareerror"
},
"example": {
"output": {
"trans-id": "62621e75-df7e-475a-8cba-0e618730753c",
"completion-status": "failure",
"final-result": [
{
"input": {
"device-name": "device-1",
"action": "Activate Device Software",
"prev-blocking": true
},
"output": {
"error_description": "Software activation is not performed as the candidate revision:11971320F1-ML-6713 is not same as target revision:NA"
}
}
]
}
}
},
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/JobRun-DownloadSoftwareOnlywitherror"
},
"example": {
"output": {
"trans-id": "e45d3232-ad05-4e6c-a6b4-e58e62ce1212",
"completion-status": "failure",
"final-result": [
{
"input": {
"device-name": "device-1",
"action": "Download Software Only",
"prev-blocking": true
},
"output": {
"error_description": "Warning: upgrade failed! Target version is not defined"
}
}
]
}
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-job-manager:pending-jobs/user-initiated/size": {
"get": {
"tags": [
"User Initiated Pending Jobs"
],
"summary": "Get User Initiated Pending Jobs Size",
"description": "Fetches size of user-initiated pending jobs list.\n\n Response Details\n\n|Attribute|Description|\n|---|---|\n|size|This represents the size of the user initiated pending job list. Possible values: 32 bit integer|",
"operationId": "GetUserInitiatedPendingJobsSize",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Mon, 26 Oct 2020 15:40:02 GMT"
},
"example": "Mon, 26 Oct 2020 15:40:02 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Vary": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
},
"example": "Accept-Encoding"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "gzip"
},
"example": "gzip"
}
}
}
},
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/GetUserInitiatedPendingJobsSize"
},
"example": {
"size": 1
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-job-manager:pending-jobs/user-initiated": {
"get": {
"tags": [
"User Initiated Pending Jobs"
],
"summary": "Get User Initiated Pending Jobs List",
"description": "Fetches collection of user initiated pending jobs, along with the size of that collection.\n\n Response Details\n\n|Attribute|Description|\n|---|---|\n|size|This represents the size of the user initiated pending job list. Possible values:32 bit integer|\n|job|List of user initiated pending jobs.|\n|name|The name of the job.|\n|uuid|The unique identifier of the job.|",
"operationId": "GetUserInitiatedPendingJobsList",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Mon, 26 Oct 2020 15:44:06 GMT"
},
"example": "Mon, 26 Oct 2020 15:44:06 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Vary": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
},
"example": "Accept-Encoding"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "gzip"
},
"example": "gzip"
}
}
}
},
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/GetUserInitiatedPendingJobsList"
},
"example": {
"size": 1,
"job": [
{
"name": "example-job-1",
"uuid": "43169f85-edc2-4d54-b32f-6428b7e89ada"
}
]
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-job-manager:pending-jobs/user-initiated/job": {
"get": {
"tags": [
"User Initiated Pending Jobs"
],
"summary": "Get User Initiated Pending Jobs",
"description": "Fetches collection of user initiated pending jobs.\n\n Response Details\n\n|Attribute|Description|\n|---|---|\n|name|The name of the job.|\n|uuid|The unique identifier of the job.|",
"operationId": "GetUserInitiatedPendingJobs",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Mon, 26 Oct 2020 15:49:54 GMT"
},
"example": "Mon, 26 Oct 2020 15:49:54 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Vary": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
},
"example": "Accept-Encoding"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "gzip"
},
"example": "gzip"
}
}
}
},
"content": {
"application/json;charset=utf-8": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetUserInitatedPendingJob"
},
"description": "",
"example": [
{
"name": "example-job-1",
"uuid": "43169f85-edc2-4d54-b32f-6428b7e89ada"
},
{
"name": "example-job-1",
"uuid": "2dc8aa11-6a93-41f9-a329-c16d7ee7a381"
}
]
},
"example": [
{
"name": "example-job-1",
"uuid": "43169f85-edc2-4d54-b32f-6428b7e89ada"
},
{
"name": "example-job-1",
"uuid": "2dc8aa11-6a93-41f9-a329-c16d7ee7a381"
}
]
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-job-manager:pending-jobs/user-initiated/job=2dc8aa11-6a93-41f9-a329-c16d7ee7a381": {
"delete": {
"tags": [
"User Initiated Pending Jobs"
],
"summary": "Delete User Initiated Pending Job",
"description": "Deletes the user initiated pending job with respect to passed query parameter in request URL.\n\n\n Request URL Query Data Details\n\n|Attribute|Description|\n|---|---|\n|uuid|**Required** uuid of the user initiated pending job to be deleted.|",
"operationId": "DeleteUserInitiatedPendingJob",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Mon, 26 Oct 2020 16:00:16 GMT"
},
"example": "Mon, 26 Oct 2020 16:00:16 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Vary": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
},
"example": "Accept-Encoding"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "gzip"
},
"example": "gzip"
}
}
}
},
"content": {}
},
"404": {
"description": "Not Found",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Mon, 26 Oct 2020 16:00:16 GMT"
},
"example": "Mon, 26 Oct 2020 16:00:16 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Vary": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
},
"example": "Accept-Encoding"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "gzip"
},
"example": "gzip"
}
}
}
},
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/DeleteUserInitiatedPendingJobwithinvaliduuid1"
},
"example": {
"message": "Job does not exist."
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-job-manager:pending-jobs/spawned/size": {
"get": {
"tags": [
"Spawned Pending Jobs"
],
"summary": "Get Spawned Pending Jobs Size",
"description": "Fetches size of spawned pending jobs list.\n\n Response Details\n\n|Attribute|Description|\n|---|---|\n|size|This represents the size of the spawned pending job list. Possible values: 32 bit integer|\n\n### Note\nSpawned jobs are sub-jobs originating from user initiated jobs.",
"operationId": "GetSpawnedPendingJobsSize",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Mon, 26 Oct 2020 15:41:29 GMT"
},
"example": "Mon, 26 Oct 2020 15:41:29 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Vary": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
},
"example": "Accept-Encoding"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "gzip"
},
"example": "gzip"
}
}
}
},
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/GetSpawnedPendingJobsSize"
},
"example": {
"size": 1
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-job-manager:pending-jobs/spawned": {
"get": {
"tags": [
"Spawned Pending Jobs"
],
"summary": "Get Spawned Pending Jobs List",
"description": "Fetches collection of spawned pending jobs, along with the size of that collection.\n\n Response Details\n\n|Attribute|Description|\n|---|---|\n|size|This represents the size of the spawned pending job list. Possible values: 32 bit integer|\n|job|List of spawned pending jobs.|\n|name|The name of the job.|\n|uuid|The unique identifier of the job.|\n\n### Note\nSpawned jobs are sub-jobs originating from user initiated jobs.",
"operationId": "GetSpawnedPendingJobsList",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Mon, 26 Oct 2020 15:46:06 GMT"
},
"example": "Mon, 26 Oct 2020 15:46:06 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Vary": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
},
"example": "Accept-Encoding"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "gzip"
},
"example": "gzip"
}
}
}
},
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/GetSpawnedPendingJobsList"
},
"example": {
"size": 1,
"job": [
{
"name": "example-job-1",
"uuid": "43169f85-edc2-4d54-b32f-6428b7e89ada"
}
]
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-job-manager:pending-jobs/spawned/job": {
"get": {
"tags": [
"Spawned Pending Jobs"
],
"summary": "Get Spawned Pending Jobs",
"description": "Fetches collection of spawned pending jobs.\n\n Response Details\n\n|Attribute|Description|\n|---|---|\n|name|The name of the job.|\n|uuid|The unique identifier of the job.|\n\n### Note\nSpawned jobs are sub-jobs originating from user initiated jobs.",
"operationId": "GetSpawnedPendingJobs",
"parameters": [],
"responses": {
"default": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetSpawnedPendingJob"
},
"description": "",
"example": [
{
"name": "example-job-1",
"uuid": "43169f85-edc2-4d54-b32f-6428b7e89ada"
},
{
"name": "example-job-1",
"uuid": "2dc8aa11-6a93-41f9-a329-c16d7ee7a381"
}
]
},
"example": [
{
"name": "example-job-1",
"uuid": "43169f85-edc2-4d54-b32f-6428b7e89ada"
},
{
"name": "example-job-1",
"uuid": "2dc8aa11-6a93-41f9-a329-c16d7ee7a381"
}
]
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-job-manager:executing-jobs/size": {
"get": {
"tags": [
"Executing Jobs"
],
"summary": "Get Executing Jobs Size",
"description": "Fetches size of the executing jobs list, to include both user initiated and spawned jobs.\n\n### Note\nJob queuing is disabled by default, which will make this return a size of 0.\n\n Response Details\n\n|Attribute|Description|\n|---|---|\n|size|This represents the size of the executing job list. Possible values: 32 bit integer|",
"operationId": "GetExecutingJobsSize",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Mon, 26 Oct 2020 15:42:33 GMT"
},
"example": "Mon, 26 Oct 2020 15:42:33 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Vary": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
},
"example": "Accept-Encoding"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "gzip"
},
"example": "gzip"
}
}
}
},
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/GetExecutingJobsSize"
},
"example": {
"size": 1
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-job-manager:executing-jobs": {
"get": {
"tags": [
"Executing Jobs"
],
"summary": "Get Executing Jobs List",
"description": "Fetches collection of executing jobs, along with the size of that collection. This includes both user initiated and spawned jobs.\n\n### Note\nJob queuing is disabled by default, which will make this response return an empty list and a size of 0.\n\n Response Details\n\n|Attribute|Description|\n|---|---|\n|size|This represents the size of the executing job list. Possible values: 32 bit integer|\n|job|List of executing jobs.|\n|name|The name of the job.|\n|uuid|The unique identifier of the job.|",
"operationId": "GetExecutingJobsList",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Mon, 26 Oct 2020 15:48:14 GMT"
},
"example": "Mon, 26 Oct 2020 15:48:14 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Vary": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
},
"example": "Accept-Encoding"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "gzip"
},
"example": "gzip"
}
}
}
},
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/GetExecutingJobsList"
},
"example": {
"size": 1,
"job": [
{
"name": "example-job-1",
"uuid": "43169f85-edc2-4d54-b32f-6428b7e89ada"
}
]
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-job-manager:executing-jobs/job": {
"get": {
"tags": [
"Executing Jobs"
],
"summary": "Get Executing Jobs",
"description": "Fetches collection of executing jobs, to include both user initiated and spawned jobs.\n\n Response Details\n\n|Attribute|Description|\n|---|---|\n|name|The name of the job.|\n|uuid|The unique identifier of the job.|",
"operationId": "GetExecutingJobs",
"parameters": [],
"responses": {
"default": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetExecutingJobswithinvaliduuid"
},
"example": {
"message": "Job does not exist."
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-jobs:jobs/job=Resynchronize NETCONF Alarms Job": {
"get": {
"tags": [
"Jobs"
],
"summary": "Get Job By Name",
"description": "Fetches a list of MCP jobs. Returns a list of attributes as a response.\n\n| Attribute | Description |\n|------------------|------------------------------------------------------------------|\n| job-name | This represents the name of the job. Possible values:string with length 1..250 |\n| state |\tThis represents state of the specific job. Possible values: configured, deployed, activated |\n| action | The action that the job will run. |\n| trigger | The trigger that will cause the job to run. |\n| trigger-context | The context parameters required for this job trigger. Possible Values: trigger: \"On Activate\" then it will be empty list. trigger: \"Date-Time\" then type: \"cron-expression\" name: \"cron-expression\" value: Uses the quartz cron scheduler. Cron expression format defined at http://www.quartz-scheduler.org. eg. 0 40 4 9 5 ? 2020 which specifies \"At 04:40:00am, on the 9th day, in May, in 2020\" hint: \"The desired cron expression for triggering the job firing schedule\" |\n| action-context |\tThis object contains a list parameters specific to the action, and will vary from action to action. For some actions this object may be empty. |\n| action-context
name
|\tName of the context parameter. |\n| action-context
value
|\tDefines the value of the context parameter as a single string. |\n| action-context
value-list
|\tDefines the value of the context parameter as a list of strings. |\n| action-context
type
|\tType of information that is represented in this field of job context. This may be used by a User Interface to create a list of suitable values from which to select. Possible values: device, interface, management-domain, server, service, content-provider, profile, profile-vector, job |\n| action-context
subtype
|\tA list of strings that provide more information about the acceptable values for this context element. The meaning depends on the type. eg. if type is `device`, this is a list of acceptable model names. If type is `list`, this is the list of possible values |\n| action-context
hint
|\tThis represents a textual short description of applicable values and its unit of measure. |\n| action-context
filter-list
|\tThis represents filter list options. |\n| action-context
filter-criteria
|\tThe filter-criteria that will used for filtering the objects. Possible values: by-label, by-management-domain, by-parent-device, by-name |",
"operationId": "GetJobByName",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 08 May 2020 11:53:47 GMT"
},
"example": "Fri, 08 May 2020 11:53:47 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "294"
},
"example": "294"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "private, no-cache"
},
"example": "private, no-cache"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "\"42961031-7adf-4edb-8069-101e2c1bff38\""
},
"example": "\"42961031-7adf-4edb-8069-101e2c1bff38\""
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/GetJobByname-Success"
},
"example": {
"state": "deployed",
"job-name": "Get PON Oper Status",
"trigger-context": [],
"action": "Get PON Operational Status",
"action-context": [
{
"filter-list": [],
"name": "interface-name",
"subtype": [],
"hint": "Interface Name.",
"type": "interface",
"value": "Put your Interface name here"
}
],
"trigger": "On Activate"
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-uiworkflow-jobs:jobs/job": {
"get": {
"tags": [
"Jobs"
],
"summary": "Get All Jobs",
"description": "Fetches collection of jobs, along with the job status, which can be executed on the system.\n\n**Response Details**\n\n| Attribute | Description |\n|------------------|------------------------------------------------------------------|\n| job-name | This represents the name of the job. Possible values:string with length 1..250 |\n| state |\tThis represents state of the specific job. Possible values: configured, deployed, activated |\n| action | The action that the job will run. |\n| trigger | The trigger that will cause the job to run. |\n| trigger-context | The context parameters required for this job trigger. Possible Values: trigger: \"On Activate\" then it will be empty list. trigger: \"Date-Time\" then type: \"cron-expression\" name: \"cron-expression\" value: Uses the quartz cron scheduler. Cron expression format defined at http://www.quartz-scheduler.org. eg. 0 40 4 9 5 ? 2020 which specifies \"At 04:40:00am, on the 9th day, in May, in 2020\" hint: \"The desired cron expression for triggering the job firing schedule\" |\n| action-context |\tThis object contains a list parameters specific to the action, and will vary from action to action. For some actions this object may be empty. |\n| action-context
name
|\tName of the context parameter. |\n| action-context
value
|\tDefines the value of the context parameter as a single string. |\n| action-context
value-list
|\tDefines the value of the context parameter as a list of strings. |\n| action-context
type
|\tType of information that is represented in this field of job context. This may be used by a User Interface to create a list of suitable values from which to select. Possible values: device, interface, management-domain, server, service, content-provider, profile, profile-vector, job |\n| action-context
subtype
|\tA list of strings that provide more information about the acceptable values for this context element. The meaning depends on the type. eg. if type is `device`, this is a list of acceptable model names. If type is `list`, this is the list of possible values |\n| action-context
hint
|\tThis represents a textual short description of applicable values and its unit of measure. |\n| action-context
filter-list
|\tThis represents filter list options. |\n| action-context
filter-criteria
|\tThe filter-criteria that will used for filtering the objects. Possible values: by-label, by-management-domain, by-parent-device, by-name |",
"operationId": "GetAllJobs",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Thu, 07 May 2020 07:14:05 GMT"
},
"example": "Thu, 07 May 2020 07:14:05 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "313"
},
"example": "313"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/GetJobs"
},
"example": {
"jobs": {
"job": [
{
"state": "deployed",
"job-name": "Get PON Oper Status",
"trigger-context": [],
"action": "Get PON Operational Status",
"action-context": [
{
"filter-list": [],
"name": "interface-name",
"subtype": [],
"hint": "Interface Name.",
"type": "interface",
"value": "Put your Interface name here"
}
],
"trigger": "On Activate"
}
]
}
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-uiworkflow-jobs:actions/action": {
"get": {
"tags": [
"Jobs"
],
"summary": "Get All Job Actions",
"description": "Fetches collection of all job types (actions) available in Mosaic CP. The makeup of this list will be based on the plugins that are loaded on the Mosaic CP server. The actions returned represent the possible values to use for the `action` field when creating or configuring a job.\n\n**Response Details**\n\n| Attribute| Description |\n|---------|------------------|\n| action |A list of cloud platform job actions. |",
"operationId": "GetAllJobActions",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Thu, 07 May 2020 10:50:28 GMT"
},
"example": "Thu, 07 May 2020 10:50:28 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "1171"
},
"example": "1171"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/GetAllJobsActions"
},
"example": {
"action": [
"Activate Device Software",
"Backup Device Configuration",
"Commit",
"Download",
"Download and Commit",
"Download Software Only",
"Download Software Only by Label",
"Download Software Only by Management Domain",
"Get ONU by Name",
"Get ONU by Serial Number",
"Get ONU Ethernet Data by Interface Name",
"Get ONU Ethernet Data by Service Name",
"Get ONU FEC Counters",
"Get ONU FEC Counters by Channel Partition",
"Get ONU Service Error Statistics",
"Get ONU Service State",
"Get ONUs by Channel Partition",
"Get PON Operational Status",
"Get Unrecognized ONUs by PON",
"Get XPON Pluggable Interface for Device",
"Handover Channel Partition",
"Handover OLT",
"Handover ONU",
"Reboot Device",
"Reboot Interface",
"Collect DPU Data One Device",
"Collect DPU Data",
"Execute SELT Test",
"Execute MELT Self Test",
"Execute MELT Test",
"Get MELT Test Result",
"Get MELT Test Status",
"Retrieve Diagnostic Reports",
"Retrieve Exception Reports",
"Set XLOG Disturber",
"Upgrade GFast CPEs",
"Delete GFast Client Data by Interface",
"Change G.fast Interface Admin State",
"Reflow Device",
"Reflow Device Only",
"Reflow Interface",
"Reflow Service",
"Restore Device Configuration",
"Resynchronize NETCONF Alarms"
]
}
}
}
}
},
"deprecated": false
}
},
"/operations/adtran-cloud-platform-uiworkflow-jobs:get-job-context": {
"post": {
"tags": [
"Jobs"
],
"summary": "Get Job Context",
"description": "Fetches job context required by the provided input. Returns a list of attributes as a response.\n\n| Attribute | Description |\n|------------------|------------------------------------------------------------------|\n| trigger-name | A name that identifies the job trigger. |\n| action-name |\tA name that identifies the job action. |\n\n\n \nResponse Data Details - \n \n\n| Attribute | Description |\n|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| name |\tName of the context parameter. |\n| value |\tDefines the value of the context parameter as a single string. |\n| value-list |\tDefines the value of the context parameter as a list of strings. |\n| type |\tType of information that is represented in this field of job context. This may be used by a User Interface to create a list of suitable values from which to select. Possible values: device, interface, management-domain, server, service, content-provider, profile, profile-vector, job |\n| subtype |\tA list of strings that provide more information about the acceptable values for this context element. The meaning depends on the type. eg., if type is 'device', this is a list of acceptable model names. If type is 'list', this is the list of possible values |\n| hint |\tThis represents a textual short description of applicable values and its unit of measure. |\n| method | HTTP method used for request by the user. Possible Values: post |\n| uri | URI requested by the user. |\n| content |\tContent or body of request by the user. |",
"operationId": "GetJobContext",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetJobContextRequest"
},
"example": {
"input": {
"action-name": "Restore Device Configuration"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Wed, 13 May 2020 09:55:56 GMT"
},
"example": "Wed, 13 May 2020 09:55:56 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "402"
},
"example": "402"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/GetJobContext"
},
"example": {
"output": {
"action-context": [
{
"value-list": [],
"name": "Device Name",
"subtype": [
"NGPON2 16P OLT Access Switch",
"SDX 6310 16-port 10G OLT",
"SDX 6010 16-port GPON OLT",
"SDX 8310 32x100 ToR Switch",
"SDX 8310-32",
"SDX 8210-54",
"SDX 8305-20",
"SDX 6312 4-port Combo Remote OLT",
"SDX 6320 16-port Combo OLT"
],
"hint": "The name of the device to restore the configuration.",
"type": "device"
}
],
"trigger-context": []
}
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-uiworkflow-jobs:triggers": {
"get": {
"tags": [
"Jobs"
],
"summary": "Get Job Triggers",
"description": "Fetches list of all job triggers. Returns a list of attributes as a response.\n\n| Attribute | Description |\n|------------------|------------------------------------------------------------------|\n| trigger-name | A name that identifies the job trigger. |",
"operationId": "GetJobTriggers",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 08 May 2020 12:34:10 GMT"
},
"example": "Fri, 08 May 2020 12:34:10 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "40"
},
"example": "40"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/GetJobTrigger-Success"
},
"example": {
"triggers": {
"trigger": [
"On Activate"
]
}
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-information:information": {
"get": {
"tags": [
"Platform Information"
],
"summary": "Get Platform Information",
"description": "A collection of basic platform information.\n\n**Response Details**\n\n| Attribute | Description |\n|---|---|\n| name | The name of the platform. |\n| software-version\t| The software version of the platform. |",
"operationId": "GetPlatformInformation",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Sat, 09 May 2020 11:15:11 GMT"
},
"example": "Sat, 09 May 2020 11:15:11 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "65"
},
"example": "65"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "private, no-cache"
},
"example": "private, no-cache"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "\"45ee7780-f110-45be-b033-82f5c67daa9e\""
},
"example": "\"45ee7780-f110-45be-b033-82f5c67daa9e\""
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/GetPlatformInformation"
},
"example": {
"information": {
"name": "Mosaic CP",
"software-version": "20.3-20"
}
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-plugin:plugins": {
"get": {
"tags": [
"Platform Information"
],
"summary": "Get Plugin Details",
"description": "Returns available plugins in MCP.\n\n**Response Details**\n\n| Attribute| Description |\n|---|---|\n| name | Plugin name. |\n| type \t| Plugin type. |\n| build-version | Plugin build version. |\n| library-version | Plugin library version.|",
"operationId": "GetPluginDetails",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Wed, 06 May 2020 09:48:28 GMT"
},
"example": "Wed, 06 May 2020 09:48:28 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "563"
},
"example": "563"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/GetPluginDetails"
},
"example": {
"plugin": {
"plugin": [
{
"type": "zip_module",
"name": "adtn_1u_olt",
"build-version": "2.0.1518",
"library-version": [
4,
1,
10
]
},
{
"type": "zip_module",
"name": "service_summary",
"build-version": "2.1.32",
"library-version": [
4,
1,
10
]
},
{
"type": "zip_module",
"name": "adtn_tor_switch",
"build-version": "1.4.53",
"library-version": [
4,
1,
10
]
},
{
"type": "zip_module",
"name": "adtn_omci_onu",
"build-version": "1.0.44",
"library-version": [
4,
1,
10
]
},
{
"type": "zip_module",
"name": "mcp_general",
"build-version": "5.18.578",
"library-version": [
4,
1,
10
]
}
]
}
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-uiworkflow-part-numbers:part-numbers/part-number": {
"get": {
"tags": [
"Platform Information"
],
"summary": "Get All Model Names in Mosaic CP",
"description": "Fetches a list of model names and their part numbers.\n\n**Response Details**\n\n| Attribute | Description |\n|---|---|\n|model-name|The model name of the physical device.|\n| part-number | ID number of part. |",
"operationId": "GetAllModelNamesinMosaicCP",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Thu, 07 May 2020 10:54:21 GMT"
},
"example": "Thu, 07 May 2020 10:54:21 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "1013"
},
"example": "1013"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetAllPartNumber"
},
"description": "",
"example": [
{
"part-number": "GENERIC",
"model-name": "Generic Device"
},
{
"part-number": "11971101F1",
"model-name": "SDX 8310-32"
},
{
"part-number": "11971101F1",
"model-name": "SDX 8310 32x100 ToR Switch"
},
{
"part-number": "11971102F1",
"model-name": "SDX 8210-54"
},
{
"part-number": "11971211F1",
"model-name": "SDX 8305-20"
},
{
"part-number": "11971320F1",
"model-name": "SDX 6310 16-port 10G OLT"
},
{
"part-number": "11971305Fx",
"model-name": "SDX 6010 16-port GPON OLT"
},
{
"part-number": "11971310F1",
"model-name": "SDX 6312 4-port Combo Remote OLT"
},
{
"part-number": "11971330F1",
"model-name": "SDX 6320 16-port Combo OLT"
},
{
"part-number": "1287820F2",
"model-name": "SDX 602V NGPON2 IBONT"
},
{
"part-number": "1287823F3",
"model-name": "SDX 621X XGS-PON ONU"
},
{
"part-number": "1287821F1",
"model-name": "SDX 621V NGPON2 ONU"
},
{
"part-number": "1287821F2V",
"model-name": "SDX 602V NGPON2 IBONT"
},
{
"part-number": "1287786FA",
"model-name": "401 GPON ONU"
},
{
"part-number": "1287787F1",
"model-name": "411 GPON ONU"
},
{
"part-number": "1287833F1",
"model-name": "SDX 611 GPON ONU"
}
]
},
"example": [
{
"part-number": "GENERIC",
"model-name": "Generic Device"
},
{
"part-number": "11971101F1",
"model-name": "SDX 8310-32"
},
{
"part-number": "11971101F1",
"model-name": "SDX 8310 32x100 ToR Switch"
},
{
"part-number": "11971102F1",
"model-name": "SDX 8210-54"
},
{
"part-number": "11971211F1",
"model-name": "SDX 8305-20"
},
{
"part-number": "11971320F1",
"model-name": "SDX 6310 16-port 10G OLT"
},
{
"part-number": "11971305Fx",
"model-name": "SDX 6010 16-port GPON OLT"
},
{
"part-number": "11971310F1",
"model-name": "SDX 6312 4-port Combo Remote OLT"
},
{
"part-number": "11971330F1",
"model-name": "SDX 6320 16-port Combo OLT"
},
{
"part-number": "1287820F2",
"model-name": "SDX 602V NGPON2 IBONT"
},
{
"part-number": "1287823F3",
"model-name": "SDX 621X XGS-PON ONU"
},
{
"part-number": "1287821F1",
"model-name": "SDX 621V NGPON2 ONU"
},
{
"part-number": "1287821F2V",
"model-name": "SDX 602V NGPON2 IBONT"
},
{
"part-number": "1287786FA",
"model-name": "401 GPON ONU"
},
{
"part-number": "1287787F1",
"model-name": "411 GPON ONU"
},
{
"part-number": "1287833F1",
"model-name": "SDX 611 GPON ONU"
}
]
}
}
}
},
"deprecated": false
}
},
"/data/adtran-feature-flags:feature-flags": {
"get": {
"tags": [
"Platform Capabilities"
],
"summary": "Get Feature Flag",
"description": "A list of feature flags to enable or disable at runtime.\n\n \nResponse Details\n\n\n| Attribute | Description |\n|---|---|\n|name |The name of the feature that can be disabled at runtime.|\n|enabled|Whether the feature is currently enabled. Possible values:true, false|\n|description |Description of the feature.|",
"operationId": "GetFeatureFlag",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 08 May 2020 11:35:06 GMT"
},
"example": "Fri, 08 May 2020 11:35:06 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "131"
},
"example": "131"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "private, no-cache"
},
"example": "private, no-cache"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "\"6649f66a-43da-4b3d-935f-77df7779607f\""
},
"example": "\"6649f66a-43da-4b3d-935f-77df7779607f\""
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/GetFeatureFlag"
},
"example": {
"feature-flags": {
"flag": [
{
"name": "CSV Export",
"description": "Export contents of various tables to CSV format.",
"enabled": false
}
]
}
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-uiworkflow-force-actions:force-actions": {
"get": {
"tags": [
"Platform Capabilities"
],
"summary": "Get Force Actions",
"description": "Fetches the list of force actions for all object types. Object types are described below: \n\n**Response Details**\n\n| Attribute | Description |\n|---|---|\n| type | Object type. |\n|configure|Specifies whether user can perform force configure or not.|\n| deploy \t| Specifies whether user can perform force deploy or not. |\n|activate | Specifies whether user can perform force activate or not. |\n| deactivate |Specifies whether user can perform force deactivate or not. |\n|undeploy |Specifies whether user can perform force undeploy or not.|\n|delete|Specifies whether user can perform force delete or not.|",
"operationId": "GetForceActions",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Thu, 07 May 2020 11:53:19 GMT"
},
"example": "Thu, 07 May 2020 11:53:19 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "1502"
},
"example": "1502"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/GetForceActions"
},
"example": {
"force-actions": {
"force-action": [
{
"deactivate": false,
"undeploy": false,
"configure": false,
"delete": false,
"deploy": false,
"type": "profile-vector",
"activate": false
},
{
"deactivate": false,
"undeploy": false,
"configure": false,
"delete": false,
"deploy": false,
"type": "bundle",
"activate": false
},
{
"deactivate": false,
"undeploy": false,
"configure": false,
"delete": false,
"deploy": false,
"type": "server",
"activate": false
},
{
"deactivate": false,
"undeploy": false,
"configure": false,
"delete": false,
"deploy": false,
"type": "content-provider",
"activate": false
},
{
"deactivate": false,
"undeploy": false,
"configure": false,
"delete": false,
"deploy": false,
"type": "management-domain",
"activate": false
},
{
"deactivate": false,
"undeploy": false,
"configure": false,
"delete": false,
"deploy": false,
"type": "subscriber",
"activate": false
},
{
"deactivate": false,
"undeploy": false,
"configure": false,
"delete": false,
"deploy": true,
"type": "interface",
"activate": false
},
{
"deactivate": false,
"undeploy": false,
"configure": false,
"delete": false,
"deploy": false,
"type": "data-center",
"activate": false
},
{
"deactivate": false,
"undeploy": false,
"configure": false,
"delete": false,
"deploy": false,
"type": "job",
"activate": false
},
{
"deactivate": false,
"undeploy": false,
"configure": false,
"delete": false,
"deploy": false,
"type": "service",
"activate": false
},
{
"deactivate": false,
"undeploy": false,
"configure": false,
"delete": false,
"deploy": false,
"type": "profile",
"activate": false
},
{
"deactivate": false,
"undeploy": false,
"configure": false,
"delete": false,
"deploy": true,
"type": "device",
"activate": false
}
]
}
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-ui-capabilities:ui-config": {
"get": {
"tags": [
"Platform Capabilities"
],
"summary": "Get UI Capabilities",
"description": "Fetches UI capabilities and returns whether they are enabled or disabled. This is used to inform the Mosaic CP GUI about platform capabilities.\n\n**Response Details**\n\n| Attribute | Description |\n|---|---|\n| suspend-resume-on-services | Whether the capability is enabled (`true`) or disabled (`false`). Possible values: true or false |",
"operationId": "GetUICapabilities",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "FRI, 26 JUNE 2020 18:53:19 GMT"
},
"example": "FRI, 26 JUNE 2020 18:53:19 GMT"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/GetUICapabilities"
},
"example": {
"suspend-resume-on-services": false
}
}
}
}
},
"deprecated": false
}
},
"/operations/adtran-cloud-platform-status:check": {
"post": {
"tags": [
"Status Check"
],
"summary": "Platform Status Check",
"description": "Fetches the status of Elasticsearch, Kafka and Zookeeper.\n\n**Response Details**\n\n| Attribute | Description |\n|---|---|\n| elastic \t| Elasticsearch Status. |\n| kafka | Kafka Status. |\n| zookeeper | Zookeeper Status. |\n\n---\n\n**NOTE**\n\nRemoved in Mosaic CP 21.2.\n\n---",
"operationId": "PlatformStatusCheck",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Thu, 07 May 2020 05:25:41 GMT"
},
"example": "Thu, 07 May 2020 05:25:41 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "78"
},
"example": "78"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/PlatformStatusCheck"
},
"example": {
"output": {
"zookeeper": "running",
"elastic": "running",
"kafka": "running"
}
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-system-monitor:nodes-summary": {
"get": {
"tags": [
"Status Check"
],
"summary": "Get Nodes Summary using System Monitor",
"description": "Fetches information on node summary excluding service data.\n\n**Response Details**\n\n| Attribute| Description |\n|---|---|\n| nodes-summary | Container to store node summary information without service data. |\n| node \t| Node in a datacenter. Information related to node. |\n| node-id | Node identity, may be IP Address, hostname, UUID, etc.. |\n| node-status | Status of the node.|",
"operationId": "GetNodesSummaryusingSystemMonitor",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Thu, 07 May 2020 05:16:49 GMT"
},
"example": "Thu, 07 May 2020 05:16:49 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "63"
},
"example": "63"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/GetSystemMonitorNodesSummary"
},
"example": {
"nodes-summary": {
"node": [
{
"node-id": "1",
"status": "up"
}
]
}
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-system-monitor:nodes": {
"get": {
"tags": [
"Status Check"
],
"summary": "Get Nodes using System Monitor",
"description": "Fetches the node information.\n\n**Response Details**\n\n| Attribute| Description |\n|---|---|\n| nodes \t| Container to store node and respective service data. |\n| node | Node in a datacenter. |\n| node-id | Node identity, may be IP Address, hostname, UUID, etc.|\n| status | Status of the service.|\n| service | A microservice running on the node.|\n| name | Name of the service.|\n| status | Status of the service.|",
"operationId": "GetNodesusingSystemMonitor",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Thu, 07 May 2020 05:20:03 GMT"
},
"example": "Thu, 07 May 2020 05:20:03 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "1379"
},
"example": "1379"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/GetNodesusingSystemMonitor"
},
"example": {
"nodes": {
"node": [
{
"node-id": "1",
"status": "up",
"service": [
{
"name": "address-resolution-service",
"status": "up"
},
{
"name": "captive-portal-script-exec",
"status": "up"
},
{
"name": "cloud-platform-deferred-intent-service",
"status": "up"
},
{
"name": "cloud-platform-event-workflow",
"status": "up"
},
{
"name": "cloud-platform-http-service",
"status": "up"
},
{
"name": "cloud-platform-job-manager",
"status": "up"
},
{
"name": "cloud-platform-uiworkflow",
"status": "up"
},
{
"name": "cloud-platform-universal-inspect-workflow",
"status": "up"
},
{
"name": "cluster-monitor",
"status": "up"
},
{
"name": "device-layer",
"status": "up"
},
{
"name": "elastic-exec",
"status": "up"
},
{
"name": "event-forwarding",
"status": "up"
},
{
"name": "export-data-service",
"status": "up"
},
{
"name": "firefly-aaa",
"status": "up"
},
{
"name": "firefly-manifests",
"status": "up"
},
{
"name": "kafka-manager",
"status": "up"
},
{
"name": "marshal-plugins",
"status": "up"
},
{
"name": "mosaic-cp-cda",
"status": "up"
},
{
"name": "mosaic-cp-plugin",
"status": "up"
},
{
"name": "nms-server-manager-coordinator",
"status": "up"
},
{
"name": "nms-trap-forwarding",
"status": "up"
},
{
"name": "northbound-interface",
"status": "up"
},
{
"name": "protocol-session-manager",
"status": "up"
},
{
"name": "service-manager",
"status": "up"
},
{
"name": "yang-datastore",
"status": "up"
}
]
}
]
}
}
}
}
}
},
"deprecated": false
}
},
"/operations/adtran-cloud-platform-orchestration:create": {
"post": {
"tags": [
"Create Bundle"
],
"summary": "Managed Object - Create Bundle",
"description": "Creates a new `bundle` in deployed state with orchestration API.\n\n| Attribute | Description |\n|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| bundle-name | **Required:** A unique name of the bundle. |\n| bundle-id | **Required:** A bundle id associated with bundle. |\n| bundle-type | **Required:** A name of the bundle-type. |\n| profile-vector-name | A profile vector associated with bundle. |\n\n---\n**NOTE**\n\nIntroduced in Mosaic CP 21.1.\n\n---",
"operationId": "ManagedObject-CreateBundle",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManagedObject-CreateBundleRequest"
},
"example": {
"input": {
"bundle-context": {
"bundle-name": "orch-bdl-1",
"bundle-type": "Generic Bundle",
"bundle-id": "4623/1",
"profile-vector-name": "{{orch-bundle-pv1}}"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 08 Jan 2021 16:46:47 GMT"
},
"example": "Fri, 08 Jan 2021 16:46:47 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Vary": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
},
"example": "Accept-Encoding"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "gzip"
},
"example": "gzip"
}
}
}
},
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/ManagedObject-CreateBundle"
},
"example": {
"output": {
"timestamp": "2021-01-08T16:46:47.076000",
"bundle-name": "orch-bdl-1",
"status": "creating",
"trans-id": "6955e6fb-7171-45df-ae50-6ba7e963d53d",
"completion-status": "in-progress"
}
}
}
}
}
},
"deprecated": false
}
},
"/operations/adtran-cloud-platform-orchestration:modify": {
"post": {
"tags": [
"Modify Bundle"
],
"summary": "Managed Object - Modify Bundle Operation Replace with Required Parameters",
"description": "Modifies the entire bundle with given parameters (replace operation)\n\n| Attribute | Description |\n|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| bundle-name | **Required:** A unique name of the bundle. |\n| bundle-id | **Required:** A bundle id associated with bundle. |\n| bundle-type | **Required:** A name of the bundle-type. |\n| operation | **Required:** set to `replace`. If no value specified in optional parameters, it will replace optional parameters values with an empty string. |\n\n---\n**NOTE**\n\nIntroduced in Mosaic CP 21.1.\n\n---",
"operationId": "ManagedObject-ModifyBundleOperationReplacewithRequiredParameters",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManagedObject-ModifyBundleOperationReplacewithRequiredParametersRequest"
},
"example": {
"input": {
"bundle-context": {
"bundle-name": "orch-bdl-1",
"bundle-type": "Generic Bundle",
"bundle-id": "4623/1"
},
"operation": "replace"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 08 Jan 2021 16:47:44 GMT"
},
"example": "Fri, 08 Jan 2021 16:47:44 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Vary": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
},
"example": "Accept-Encoding"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "gzip"
},
"example": "gzip"
}
}
}
},
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/ManagedObject-ModifyBundleOperationReplacewithRequiredParameters"
},
"example": {
"output": {
"timestamp": "2021-01-08T16:47:44.772000",
"bundle-name": "orch-bdl-1",
"status": "modifying",
"trans-id": "1fb15ab8-5e02-45d5-a36b-efae493659aa",
"completion-status": "in-progress"
}
}
}
}
}
},
"deprecated": false
}
},
"/operations/adtran-cloud-platform-orchestration:delete": {
"post": {
"tags": [
"Delete Bundle"
],
"summary": "Managed Object - Delete Bundle",
"description": "Attempts to delete an exisiting `bundle`.\n\n| Attribute | Description |\n|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| bundle-name | **Required:** A unique name for the bundle. |\n\n---\n**NOTE**\n\nIntroduced in Mosaic CP 21.1.\n\n---",
"operationId": "ManagedObject-DeleteBundle",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManagedObject-DeleteBundleRequest"
},
"example": {
"input": {
"bundle-context": {
"bundle-name": "orch-bdl-1"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 08 Jan 2021 16:48:23 GMT"
},
"example": "Fri, 08 Jan 2021 16:48:23 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Vary": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
},
"example": "Accept-Encoding"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "gzip"
},
"example": "gzip"
}
}
}
},
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/ManagedObject-DeleteBundle"
},
"example": {
"output": {
"timestamp": "2021-01-08T16:48:23.955000",
"bundle-name": "orch-bdl-1",
"status": "deleting",
"trans-id": "5f3fa57c-80a5-46d3-a6f9-69d47efd58a9",
"completion-status": "in-progress"
}
}
}
}
}
},
"deprecated": false
}
},
"/operations/adtran-cloud-platform-uiworkflow:configure": {
"post": {
"tags": [
"Bundles"
],
"summary": "Configure Bundle",
"description": "Modifies an existing bundle in the `configured` state. Successful request returns the status of the operation, along with a transition id that can be used to verify the completion of the operation.\n\n\n \nRequest Payload Details\n\n\n|\tAttribute\t\t\t|\t\tDescription\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t |\n|-----------------------|------------------------------------------------------------------------------------------------|\n|\tbundle-name\t\t\t|**Required:** Unique name of the bundle.\t\t\t\t\t|\n|\tbundle-type |**Required:** Type of the bundle.\t\t\t\t\t\t\t|\n|\tprofile-vector-name | The profile vector of the bundle.\t\t\t\t\t\t\t|",
"operationId": "ConfigureBundle",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigureBundleRequest"
},
"example": {
"input": {
"bundle-context": {
"bundle-name": "ChannelPartition_1",
"bundle-type": "lag-interface",
"profile-vector-name": "{{bundle-pv-name}}"
}
}
}
}
},
"required": true
},
"responses": {
"409": {
"description": "Conflict",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Sat, 09 May 2020 10:06:28 GMT"
},
"example": "Sat, 09 May 2020 10:06:28 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "144"
},
"example": "144"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/ConfigureBundle-IncorrectBundleName1"
},
"example": {
"errors": {
"error-type": "rpc",
"error-tag": "Validation of precondition failed",
"error-message": "Bundle Incorrect Bundle Name does not exists."
}
}
}
}
},
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Sat, 09 May 2020 10:05:26 GMT"
},
"example": "Sat, 09 May 2020 10:05:26 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "195"
},
"example": "195"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/ConfigureBundle-Success"
},
"example": {
"output": {
"timestamp": "2020-05-09T10:05:26.492000",
"bundle-name": "ChannelPartition_1",
"status": "configuring",
"trans-id": "2ad65884-8030-47db-8636-0dd59632305a",
"completion-status": "in-progress"
}
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-uiworkflow-bundles:bundles/bundle=ChannelPartition_1": {
"get": {
"tags": [
"Bundles"
],
"summary": "Get Bundle",
"description": "This API returns the data for a specific bundle. User needs to specify the bundle name in the request.\n\n**Response Details**\n\n|\tAttribute\t\t\t\t|\t\tDescription\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t|\n|---------------------------|------------------------------------------------------------------------------------------------|\n|\tbundle-name\t\t\t | Unique name of the bundle.\t\t\t\t\t\t\t\t\t\t\t|\n|\tbundle-type | Type of the bundle.\t\t\t\t\t\t\t\t\t |\n| bundle-id | ID of bundle. Format of ID string depends on type of bundle. |\n|\tprofile-vector-name | The profile vector of the bundle.\t\t\t\t\t\t\t |\n| state |The state of the bundle. Possible Values: configured, deployed, activated |",
"operationId": "GetBundle",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Sat, 09 May 2020 10:19:04 GMT"
},
"example": "Sat, 09 May 2020 10:19:04 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "156"
},
"example": "156"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/GetBundle-Success"
},
"example": {
"state": "activated",
"bundle-name": "ChannelPartition_1",
"bundle-id": "4392/1",
"profile-vector-name": "Sample Bundle Vector",
"bundle-type": "channel-partition"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Sat, 09 May 2020 10:20:07 GMT"
},
"example": "Sat, 09 May 2020 10:20:07 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "91"
},
"example": "91"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/GetBundle-IncorrectBundleName1"
},
"example": {
"errors": {
"error-type": "application",
"error-message": "'Incorrect Bundle Name' not found"
}
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-uiworkflow-bundles:bundles/bundle": {
"get": {
"tags": [
"Bundles"
],
"summary": "Get All Bundles",
"description": "Get details of all Bundles in MCP. Returns the data for a requested bundle as described below.\n\n**Response Details**\n\n|\tAttribute\t\t\t\t|\t\tDescription\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t|\n|---------------------------|------------------------------------------------------------------------------------------------|\n|\tbundle-name\t\t\t | Unique name of the bundle.\t\t\t\t\t\t\t\t\t\t\t|\n|\tbundle-type | Type of the bundle.\t\t\t\t\t\t\t\t\t |\n| bundle-id | ID of bundle. Format of ID string depends on type of bundle. |\n|\tprofile-vector-name | The profile vector of the bundle.\t\t\t\t\t\t\t |\n| state |The state of the bundle. Possible Values: configured, deployed, activated |",
"operationId": "GetAllBundles",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Sat, 09 May 2020 10:21:15 GMT"
},
"example": "Sat, 09 May 2020 10:21:15 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "273"
},
"example": "273"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetAllBundles-Success"
},
"description": "",
"example": [
{
"state": "configured",
"bundle-name": "ChannelPartition",
"profile-vector-name": "",
"bundle-type": "channel-partition"
},
{
"state": "activated",
"bundle-name": "ChannelPartition_1",
"bundle-id": "4392/1",
"profile-vector-name": "Sample Bundle Vector",
"bundle-type": "channel-partition"
}
]
},
"example": [
{
"state": "configured",
"bundle-name": "ChannelPartition",
"profile-vector-name": "",
"bundle-type": "channel-partition"
},
{
"state": "activated",
"bundle-name": "ChannelPartition_1",
"bundle-id": "4392/1",
"profile-vector-name": "Sample Bundle Vector",
"bundle-type": "channel-partition"
}
]
}
}
}
},
"deprecated": false
}
},
"/operations/adtran-cloud-platform-uiworkflow:deactivate": {
"post": {
"tags": [
"Bundles"
],
"summary": "Deactivate Bundle",
"description": "Attempts to transition an exisiting Bundle into the `deactivated` state. This also results in reflow of the bundle. Successful request returns the status of the operation, along with a transition id that can be used to verify the completion of the operation\n\n \nRequest Payload Details\n\n\n|\tAttribute\t\t\t\t|\t\tDescription\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t|\n|---------------------------|-----------------------------------------------------------------------------------------------|\n|\tbundle-name\t\t\t\t|**Required:** Unique name of the bundle.\t\t\t\t\t\t\t\t\t\t\t\t\t\t|",
"operationId": "DeactivateBundle",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeactivateBundleRequest"
},
"example": {
"input": {
"bundle-context": {
"bundle-name": "ChannelPartition_1"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Sat, 09 May 2020 10:22:52 GMT"
},
"example": "Sat, 09 May 2020 10:22:52 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "196"
},
"example": "196"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/DeactivateBundle-Success"
},
"example": {
"output": {
"timestamp": "2020-05-09T10:22:52.087000",
"bundle-name": "ChannelPartition_1",
"status": "deactivating",
"trans-id": "925a1ff9-5f5c-42fd-a483-e94adfa76460",
"completion-status": "in-progress"
}
}
}
}
},
"409": {
"description": "Conflict",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Sat, 09 May 2020 10:23:09 GMT"
},
"example": "Sat, 09 May 2020 10:23:09 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "174"
},
"example": "174"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/DeactivateBundle-AlreadyDeactivated1"
},
"example": {
"errors": {
"error-type": "rpc",
"error-tag": "Validation of precondition failed",
"error-message": "Action 'deactivate' not allowed for ChannelPartition_1 with state 'deployed'"
}
}
}
}
}
},
"deprecated": false
}
},
"/operations/adtran-cloud-platform-uiworkflow:undeploy": {
"post": {
"tags": [
"Bundles"
],
"summary": "Undeploy Bundle",
"description": "Attempts to transition an exisiting Bundle into the `undeployed` state. Successful request returns the status of the operation, along with a transition id that can be used to verify the completion of the operation.\n\n \nRequest Payload Details\n\n\n\n|\tAttribute\t\t\t\t|\t\tDescription\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t|\n|---------------------------|-----------------------------------------------------------------------------------------------|\n|\tbundle-name\t\t\t\t|**Required:** Unique name of the bundle.\t\t\t\t\t\t\t\t\t\t\t\t\t\t|",
"operationId": "UndeployBundle",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UndeployBundleRequest"
},
"example": {
"input": {
"bundle-context": {
"bundle-name": "ChannelPartition_1"
}
}
}
}
},
"required": true
},
"responses": {
"409": {
"description": "Conflict",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Sat, 09 May 2020 10:24:02 GMT"
},
"example": "Sat, 09 May 2020 10:24:02 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "174"
},
"example": "174"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/UndeployBundle-AlreadyUndeployed1"
},
"example": {
"errors": {
"error-type": "rpc",
"error-tag": "Validation of precondition failed",
"error-message": "Action 'undeploy' not allowed for ChannelPartition_1 with state 'configured'"
}
}
}
}
},
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Sat, 09 May 2020 10:23:49 GMT"
},
"example": "Sat, 09 May 2020 10:23:49 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "195"
},
"example": "195"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/UndeployBundle-Success"
},
"example": {
"output": {
"timestamp": "2020-05-09T10:23:49.131000",
"bundle-name": "ChannelPartition_1",
"status": "undeploying",
"trans-id": "987ef3a2-2d8b-402f-866e-7b9b08996dc9",
"completion-status": "in-progress"
}
}
}
}
}
},
"deprecated": false
}
},
"/operations/adtran-cloud-platform-uiworkflow:delete": {
"post": {
"tags": [
"Bundles"
],
"summary": "Delete Bundle",
"description": "Attempts to `delete` an existing Bundle. Successful request returns the status of the operation, along with a transition id that can be used to verify the completion of the operation.\n\n \nRequest Payload Details\n\n\n|\tAttribute\t\t\t\t|\t\tDescription\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t|\n|---------------------------|-----------------------------------------------------------------------------------------------|\n|\tbundle-name\t\t\t\t|**Required:** Unique name of the bundle.\t\t\t\t\t\t\t\t\t\t\t\t\t\t|",
"operationId": "DeleteBundle",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteBundleRequest"
},
"example": {
"input": {
"bundle-context": {
"bundle-name": "ChannelPartition_1"
}
}
}
}
},
"required": true
},
"responses": {
"409": {
"description": "Conflict",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Sat, 09 May 2020 10:08:59 GMT"
},
"example": "Sat, 09 May 2020 10:08:59 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "140"
},
"example": "140"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/DeleteBundle-AlreadyDeleted1"
},
"example": {
"errors": {
"error-type": "rpc",
"error-tag": "Validation of precondition failed",
"error-message": "Bundle ChannelPartition_1 does not exists."
}
}
}
}
},
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Sat, 09 May 2020 10:08:15 GMT"
},
"example": "Sat, 09 May 2020 10:08:15 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "192"
},
"example": "192"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/DeleteBundle-Success"
},
"example": {
"output": {
"timestamp": "2020-05-09T10:08:15.257000",
"bundle-name": "ChannelPartition_1",
"status": "deleting",
"trans-id": "acd6d01f-4696-4ab6-a09a-e0f9932bd6ec",
"completion-status": "in-progress"
}
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-uiworkflow-services:content-providers/content-provider=Content-Provider": {
"get": {
"tags": [
"Content Provider"
],
"summary": "Get Content Provider",
"description": "Fetches details of a specific Content Provider mentioned in the request url. Returns the data for a requested Content Provider as described below.\n\n**Response Details**\n\n|\tAttribute\t\t\t\t|\tDescription\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t|\n|--------------------------------------|------------------------------------------------------------------------------------------------|\n|\tcontent-provider-name\t\t\t|\t The name of the content provider for the endpoint.\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t|\n|\tmultipoint-outer-vlan-id\t\t\t| Content provider's multipoint outer traffic VLAN ID. Should be used for multicast (such as video) or shared VLAN (such as management). Possible Values: untagged or vlan-id range 0..4094.\t\t\t\t\t\t\t\t\t|\n|\tmultipoint-inner-vlan-id\t\t| Content provider's multipoint inner traffic VLAN ID. Should be used for multicast (such as video) or shared VLAN (such as management). The inner-vlan-id only applies when the outer tag is a specified VLAN ID.”. Possible Values: none or vlan-id range 0..4094.\t\t\t\t\t\t\t|\n|\tprofile-vector-name\t\t| The profile vector of the content provider.\t\t\t\t\t\t\t\t\t|\n|\tinterface-name\t\t| Interface name to which content provider is attached.\t\t\t\t\t\t\t\t\t|\n|\tdevice-name\t\t| Identifies the device associated with this interface.\t\t\t\t\t\t\t\t\t|\n|\tstate\t\t| Current state of the content provider. Possible Values: configured, deployed, activated.\t\t\t\t|",
"operationId": "GetContentProvider",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 05 May 2020 08:01:48 GMT"
},
"example": "Tue, 05 May 2020 08:01:48 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "258"
},
"example": "258"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/GetContentProvider-Success"
},
"example": {
"device-name": "PON-Blade-1",
"state": "activated",
"interface-name": "PON-Blade-1-Provider-Interface",
"interface-id": "1",
"multipoint-inner-vlan-id": "none",
"multipoint-outer-vlan-id": "untagged",
"profile-vector-name": "",
"content-provider-name": "Content-Provider"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Wed, 06 May 2020 12:48:52 GMT"
},
"example": "Wed, 06 May 2020 12:48:52 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "92"
},
"example": "92"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/GetContentProvider-IncorrectContentProviderNotExists1"
},
"example": {
"errors": {
"error-type": "application",
"error-message": "'InvalidContentProvider' not found"
}
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-uiworkflow-services:content-providers/content-provider": {
"get": {
"tags": [
"Content Provider"
],
"summary": "Get All Content Providers",
"description": "Get details of all Content Providers. Returns the data for a requested Content Provider as described below.\n\n**Response Details**\n\n|\tAttribute\t\t\t\t|\tDescription\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t|\n|--------------------------------------|------------------------------------------------------------------------------------------------|\n|\tcontent-provider-name\t\t\t|\tThe name of the content provider for the endpoint.\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t|\n|\tmultipoint-outer-vlan-id\t\t\t| Content provider's multipoint outer traffic VLAN ID. Should be used for multicast (such as video) or shared VLAN (such as management). Possible Values: untagged or vlan-id range 0..4094. \t\t\t\t\t\t\t\t\t\t|\n|\tmultipoint-inner-vlan-id\t\t| Content provider's multipoint inner traffic VLAN ID. Should be used for multicast (such as video) or shared VLAN (such as management). The inner-vlan-id only applies when the outer tag is a specified VLAN ID.”. Possible Values: none or vlan-id range 0..4094.\t\t\t\t\t|\n|\tprofile-vector-name\t\t| The profile vector of the content provider.\t\t\t\t\t\t\t\t\t|\n|\tinterface-name\t\t| Interface name to which content provider is attached.\t\t\t\t\t\t\t\t\t|\n|\tdevice-name\t\t| Identifies the device associated with this interface.\t\t\t\t\t\t\t\t\t|\n|\tstate\t\t| Current state of the content provider. Possible Values: configured, deployed, activated.\t\t\t\t|",
"operationId": "GetAllContentProviders",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 05 May 2020 08:08:08 GMT"
},
"example": "Tue, 05 May 2020 08:08:08 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "260"
},
"example": "260"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETAllContentProviders-Success"
},
"description": "",
"example": [
{
"device-name": "PON-Blade-1",
"state": "activated",
"interface-name": "PON-Blade-1-Provider-Interface",
"interface-id": "1",
"multipoint-inner-vlan-id": "none",
"multipoint-outer-vlan-id": "untagged",
"profile-vector-name": "",
"content-provider-name": "Content-Provider"
}
]
},
"example": [
{
"device-name": "PON-Blade-1",
"state": "activated",
"interface-name": "PON-Blade-1-Provider-Interface",
"interface-id": "1",
"multipoint-inner-vlan-id": "none",
"multipoint-outer-vlan-id": "untagged",
"profile-vector-name": "",
"content-provider-name": "Content-Provider"
}
]
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-data-centers:data-centers/data-center=Data Center": {
"get": {
"tags": [
"Data Center"
],
"summary": "Get Data Center",
"description": "Get specific Data Center. Returns the data for a requested Data Center as described below.\n\n**Response Details**\n\n|\tAttribute\t\t\t\t|\tDescription\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t|\n|---------------------------|------------------------------------------------------------------------------------------------|\n|\tdata-center-name\t\t\t| Name of data center. Possible Values: string with length 1..250\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t|\n|\ttype\t\t\t| Data center type. \t\t\t\t\t\t\t\t\t\t\t|\n|\tprofile-vector-name\t\t|\tThe profile vector of the data center.\t\t\t\t\t\t\t\t\t|\n|\tstate\t\t| Current state of the content provider. Possible Values: configured, deployed, activated.\t\t\t\t|\n|\tavailability\t\t|\tIndicates availability of 'data center'. Default Value: unavailable. Possible Values: unavailable or available.\t\t\t\t\t\t\t\t|",
"operationId": "GetDataCenter",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Wed, 06 May 2020 06:18:06 GMT"
},
"example": "Wed, 06 May 2020 06:18:06 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "123"
},
"example": "123"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "private, no-cache"
},
"example": "private, no-cache"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "\"01180903-6423-4908-90f8-ada4c926e1f9\""
},
"example": "\"01180903-6423-4908-90f8-ada4c926e1f9\""
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/GetDataCenter-Success"
},
"example": {
"state": "activated",
"availability": "available",
"data-center-name": "Data Center",
"profile-vector-name": "",
"type": "Generic"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Wed, 06 May 2020 08:04:01 GMT"
},
"example": "Wed, 06 May 2020 08:04:01 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "126"
},
"example": "126"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/GetDataCenter-IncorrectDataCenterNotExists1"
},
"example": {
"message": "Could not find path List(adtran-cloud-platform-data-centers, data-centers, data-center=Invalid-Data-Center)"
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-data-centers:data-centers/data-center": {
"get": {
"tags": [
"Data Center"
],
"summary": "Get All Data Centers",
"description": "Gets details of all Data Centers. Returns the data for a requested bundle as described below\n\n**Response Details**\n\n|\tAttribute\t\t\t\t|\tDescription\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t|\n|---------------------------|------------------------------------------------------------------------------------------------|\n|\tdata-center-name\t\t\t| Name of data center. Possible Values: string with length 1..250\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t|\n|\ttype\t\t\t| Data center type. \t\t\t\t\t\t\t\t\t\t\t|\n|\tprofile-vector-name\t\t|\tThe profile vector of the data center.\t\t\t\t\t\t\t\t\t|\n|\tstate\t\t| Current state of the content provider. Possible Values: configured, deployed, activated\t\t\t\t|\n|\tavailability\t\t|\tIndicates availability of 'data center'. Default Value: unavailable. Possible Values: unavailable or available.\t\t\t\t\t\t\t\t|",
"operationId": "GetAllDataCenters",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Wed, 06 May 2020 05:48:32 GMT"
},
"example": "Wed, 06 May 2020 05:48:32 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "141"
},
"example": "141"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "private, no-cache"
},
"example": "private, no-cache"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "\"01180903-6423-4908-90f8-ada4c926e1f9\""
},
"example": "\"01180903-6423-4908-90f8-ada4c926e1f9\""
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/GetDataCenter-Success1"
},
"example": {
"data-center": [
{
"state": "activated",
"availability": "available",
"data-center-name": "Data Center",
"profile-vector-name": "",
"type": "Generic"
}
]
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-uiworkflow-data-center-types:data-center-types": {
"get": {
"tags": [
"Data Center"
],
"summary": "Get All Data Center Types",
"description": "Fetches list of data center type.\n\n**Response Details**\n\n| Attribute| Description |\n|---------|------------------|\n| type | Type of data center. |",
"operationId": "GetAllDataCenterTypes",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Thu, 07 May 2020 11:13:13 GMT"
},
"example": "Thu, 07 May 2020 11:13:13 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "29"
},
"example": "29"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/GetAllDataCenterTypes"
},
"example": {
"type": [
{
"type": "GENERIC"
}
]
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-device-types:device-types": {
"get": {
"tags": [
"Devices"
],
"summary": "Get All Device Types",
"description": "Fetches a list of device type information. Returns a list of attributes as a response.\n\n**Response Details**\n\n| Attribute | Description |\n|------------------|------------------------------------------------------------------|\n| schema-version | This represents the version of the schema of the data given in this repository to support migration. Possible values: 1..4,294,967,295 |\n| device-type |\tThis represents list of device type information. |\n| device-type-id | The identification type of this device type. It can be used for identification. |\n| device-type-name | A display string to show the type name of this device type. It should not be used for identification. |\n| hardware-model-name-regex |\tA regular expression that matches the vendor specific model name of the device hardware like in the second part of CPEs version-number or DPUs hardware model-name. |\n| device-type-interface |\tThis represents the interfaces of this device type. |\n| interface-type-id |\tThe identification type of this interface type. It can be used for identification. |\n| interface-type-name |\tA display string to show the type name of this interface type. It should not be used for identification. |\n| start |\tFirst element in the range. Possible values: 1..4,294,967,295 |\n| end |\tLast element in the range. Possible values: true, false |",
"operationId": "GetAllDeviceTypes",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 08 May 2020 12:15:03 GMT"
},
"example": "Fri, 08 May 2020 12:15:03 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "5076"
},
"example": "5076"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "private, no-cache"
},
"example": "private, no-cache"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "\"2e83b6aa-56b9-4487-abea-5d7971aa1b24\""
},
"example": "\"2e83b6aa-56b9-4487-abea-5d7971aa1b24\""
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/getAlldevicetypes-success"
},
"example": {
"device-types": {
"device-type": [
{
"device-type-interface": [
{
"interface-type-name": "g-fast",
"interface-type-id": "g-fast",
"ports": {
"end": 8,
"start": 1
},
"slots": {
"end": 0,
"start": 0
}
},
{
"interface-type-name": "gigabit-ethernet",
"interface-type-id": "gigabit-ethernet",
"ports": {
"end": 2,
"start": 1
},
"slots": {
"end": 0,
"start": 0
}
}
],
"device-type-model": "adtran-devices-dpu5xxg:dpu508g",
"device-type-tag": [
"DPU",
"GEN_1"
],
"device-type-name": "508G Gfast DPU",
"device-type-id": "508G Gfast DPU"
},
{
"device-type-interface": [
{
"interface-type-name": "g-fast",
"interface-type-id": "g-fast",
"ports": {
"end": 16,
"start": 1
},
"slots": {
"end": 0,
"start": 0
}
},
{
"interface-type-name": "gigabit-ethernet",
"interface-type-id": "gigabit-ethernet",
"ports": {
"end": 2,
"start": 1
},
"slots": {
"end": 0,
"start": 0
}
}
],
"device-type-model": "adtran-devices-dpu5xxg:dpu516g",
"device-type-tag": [
"DPU",
"GEN_1"
],
"device-type-name": "516G Gfast DPU",
"device-type-id": "516G Gfast DPU"
},
{
"device-type-interface": [
{
"interface-type-name": "gigabit-ethernet",
"interface-type-id": "gigabit-ethernet",
"ports": {
"end": 1,
"start": 1
},
"slots": {
"end": 0,
"start": 0
}
}
],
"device-type-model": "",
"device-type-tag": [
"CPE"
],
"device-type-name": "Gfast CPE",
"device-type-id": "Gfast CPE"
},
{
"device-type-interface": [
{
"interface-type-name": "gigabit-ethernet",
"interface-type-id": "gigabit-ethernet",
"ports": {
"end": 1,
"start": 1
},
"slots": {
"end": 0,
"start": 0
}
}
],
"device-type-model": "",
"device-type-tag": [
"CPE"
],
"device-type-name": "Gfast CPE 401G",
"device-type-id": "Gfast CPE 401G"
},
{
"device-type-interface": [
{
"interface-type-name": "gigabit-ethernet",
"interface-type-id": "gigabit-ethernet",
"ports": {
"end": 1,
"start": 1
},
"slots": {
"end": 0,
"start": 0
}
}
],
"device-type-model": "",
"device-type-tag": [
"CPE"
],
"device-type-name": "Gfast CPE 401GC",
"device-type-id": "Gfast CPE 401GC"
},
{
"device-type-interface": [
{
"interface-type-name": "gigabit-ethernet",
"interface-type-id": "gigabit-ethernet",
"ports": {
"end": 1,
"start": 1
},
"slots": {
"end": 0,
"start": 0
}
}
],
"device-type-model": "",
"device-type-tag": [
"CPE"
],
"device-type-name": "Gfast CPE 412G",
"device-type-id": "Gfast CPE 412G"
},
{
"device-type-interface": [
{
"interface-type-name": "gigabit-ethernet",
"interface-type-id": "gigabit-ethernet",
"ports": {
"end": 1,
"start": 1
},
"slots": {
"end": 0,
"start": 0
}
}
],
"device-type-model": "",
"device-type-tag": [
"CPE",
"EOC"
],
"device-type-name": "Gfast CPE 422GC",
"device-type-id": "Gfast CPE 422GC"
},
{
"device-type-interface": [
{
"interface-type-name": "g-fast",
"interface-type-id": "g-fast",
"ports": {
"end": 4,
"start": 1
},
"slots": {
"end": 0,
"start": 0
}
},
{
"interface-type-name": "gigabit-ethernet",
"interface-type-id": "gigabit-ethernet",
"ports": {
"end": 2,
"start": 1
},
"slots": {
"end": 0,
"start": 0
}
}
],
"device-type-model": "adtran-devices-sdx22xx:sdx2221-04",
"device-type-tag": [
"DPU",
"GEN_2",
"MODEL_1"
],
"device-type-name": "SDX2221-04-TP",
"device-type-id": "SDX2221-04-TP"
},
{
"device-type-interface": [
{
"interface-type-name": "g-fast",
"interface-type-id": "g-fast",
"ports": {
"end": 8,
"start": 1
},
"slots": {
"end": 0,
"start": 0
}
},
{
"interface-type-name": "gigabit-ethernet",
"interface-type-id": "gigabit-ethernet",
"ports": {
"end": 2,
"start": 1
},
"slots": {
"end": 0,
"start": 0
}
}
],
"device-type-model": "adtran-devices-sdx22xx:sdx2221-08",
"device-type-tag": [
"DPU",
"GEN_2",
"MODEL_1"
],
"device-type-name": "SDX2221-08-TP",
"device-type-id": "SDX2221-08-TP"
},
{
"device-type-interface": [
{
"interface-type-name": "g-fast",
"interface-type-id": "g-fast",
"ports": {
"end": 16,
"start": 1
},
"slots": {
"end": 0,
"start": 0
}
},
{
"interface-type-name": "gigabit-ethernet",
"interface-type-id": "gigabit-ethernet",
"ports": {
"end": 2,
"start": 1
},
"slots": {
"end": 0,
"start": 0
}
}
],
"device-type-model": "adtran-devices-sdx22xx:sdx2221-16",
"device-type-tag": [
"DPU",
"GEN_2",
"MODEL_1"
],
"device-type-name": "SDX2221-16-TP",
"device-type-id": "SDX2221-16-TP"
},
{
"device-type-interface": [
{
"interface-type-name": "g-fast",
"interface-type-id": "g-fast",
"ports": {
"end": 24,
"start": 1
},
"slots": {
"end": 0,
"start": 0
}
},
{
"interface-type-name": "gigabit-ethernet",
"interface-type-id": "gigabit-ethernet",
"ports": {
"end": 2,
"start": 1
},
"slots": {
"end": 0,
"start": 0
}
}
],
"device-type-model": "adtran-devices-sdx22xx:sdx2221-24",
"device-type-tag": [
"DPU",
"GEN_2",
"MODEL_1"
],
"device-type-name": "SDX2221-24-TP",
"device-type-id": "SDX2221-24-TP"
},
{
"device-type-interface": [
{
"interface-type-name": "g-fast",
"interface-type-id": "g-fast",
"ports": {
"end": 48,
"start": 1
},
"slots": {
"end": 0,
"start": 0
}
},
{
"interface-type-name": "gigabit-ethernet",
"interface-type-id": "gigabit-ethernet",
"ports": {
"end": 2,
"start": 1
},
"slots": {
"end": 0,
"start": 0
}
}
],
"device-type-model": "adtran-devices-sdx22xx:sdx2221-48",
"device-type-tag": [
"DPU",
"GEN_2",
"MODEL_1"
],
"device-type-name": "SDX2221-48-TP",
"device-type-id": "SDX2221-48-TP"
},
{
"device-type-interface": [
{
"interface-type-name": "g-fast",
"interface-type-id": "g-fast",
"ports": {
"end": 1,
"start": 1
},
"slots": {
"end": 0,
"start": 0
}
},
{
"interface-type-name": "gigabit-ethernet",
"interface-type-id": "gigabit-ethernet",
"ports": {
"end": 1,
"start": 1
},
"slots": {
"end": 0,
"start": 0
}
}
],
"device-type-model": "adtran-devices-sdx22xx:sdx2222-01",
"device-type-tag": [
"DPU",
"GEN_2",
"MODEL_2"
],
"device-type-name": "SDX2222-01-TP",
"device-type-id": "SDX2222-01-TP"
}
],
"schema-version": 1
}
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-uiworkflow-devices:devices/device=device_1": {
"get": {
"tags": [
"Devices"
],
"summary": "Get Device",
"description": "Fetches details of a specific device mentioned in the url. Returns the data for a requested device as described below.\n\n**Response Details**\n\n| Attribute | Description |\n|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| device-name | Name of the device. |\n| model-name | Model name of the device. |\n| part-number | Part number associated with the device. |\n| interface-name\t\t | The name of an existing interface on which to deploy the device.\t\t\t\t\t\t\t\t\t\t|\n| overridden-profiles\t\t| A list of overridden profiles to be used for this device.\t\t\t\t\t\t\t\t\t|\n| base-configuration | Base configuration associated with the device |\n| credentials-name | Name of the credentials resource. |\n| profile-vector-name | Name of the device type profile vector to associate with this device. |\n| management-domain-context | The management domain of the device. Possible Values : named, static-ipv4, external |\n| management-domain-static-ipv4 | ip-address: IP Address of device. mask: Subnet mask of IP. gateway: Gateway IP.|\n| object-parameters | Gathering object parameters. |\n| state | The state of the specific device. Possible Values: configured, deployed, activated |",
"operationId": "GetDevice",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Mon, 04 May 2020 13:59:01 GMT"
},
"example": "Mon, 04 May 2020 13:59:01 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "590"
},
"example": "590"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/GetDevice-Success-DeployedState"
},
"example": {
"device-name": "device_1",
"state": "deployed",
"base-configuration": "",
"object-parameters": {},
"part-number": "GENERIC",
"management-domain-context": {
"management-domain-type": "management-domain-static-ipv4",
"management-vlan-outer-tag": "untagged",
"management-domain-name": "static-ipv4-device_1",
"management-vlan-inner-tag": "none",
"management-domain-static-ipv4": {
"ip-address": "10.11.45.4",
"mask": "255.255.255.0",
"gateway": "255.255.244.255"
},
"persistency-server": []
},
"metadata": {
"inventory": {}
},
"profile-vector-name": "OLT Config Vector",
"model-name": "Generic Device",
"credentials-name": "OLT Cred"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Mon, 04 May 2020 14:00:05 GMT"
},
"example": "Mon, 04 May 2020 14:00:05 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "79"
},
"example": "79"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/GetDevice-IncorrectDeviceName1"
},
"example": {
"errors": {
"error-type": "application",
"error-message": "'device_11' not found"
}
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-uiworkflow-devices:devices/device": {
"get": {
"tags": [
"Devices"
],
"summary": "Get Devices using Query Params",
"description": "Provides the result against given values passed for `fields` in query request URL. Request is `GET` type.\n\n \nRequest Url Query Parameters -\n\n| Attribute | Description |\n|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| fields | Values for fields which are specific to the object-type. In the case of devices these could be `device-name`, `state`, `model-name` etc. |\n\n\n\n \n\n**Response Details** \n\n \nList of JSON objects returned in response with values that were passed in request URL.\n\n\n| Attribute | Description |\n|------------------|---------------------------------------------------------------------------------------------------------|\n| device-name \t| A unique name of the device. |\n| state \t\t\t| The indicated state of the device. Possible values: configured, deployed or activated |\n| model-name\t\t| Model name of the device. |\n\n\n \n\nNOTE : One or more device attributes can be passed to request URL to query after `fields` key. The attributes are `device-name`, `state`, `model-name`, `management-domain`, `base-configuration`, `part-number`, `profile-vector-name`, `credentials-name`. \n\n \nDifferent combination of requests can be made by using these attributes.",
"operationId": "GetDevicesusingQueryParams",
"parameters": [
{
"name": "fields",
"in": "query",
"description": "",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "device-name;state;model-name"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Sat, 09 May 2020 09:22:32 GMT"
},
"example": "Sat, 09 May 2020 09:22:32 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "175"
},
"example": "175"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataFilterByUrl-Device-GetFilteredDatum"
},
"description": "",
"example": [
{
"device-name": "device_test1",
"state": "configured",
"model-name": "SDX 6310 16-port 10G OLT"
},
{
"device-name": "rooted-device",
"state": "activated",
"model-name": "Generic Device"
}
]
},
"example": [
{
"device-name": "device_test1",
"state": "configured",
"model-name": "SDX 6310 16-port 10G OLT"
},
{
"device-name": "rooted-device",
"state": "activated",
"model-name": "Generic Device"
}
]
}
}
},
"404": {
"description": "Not Found",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Sat, 09 May 2020 09:24:58 GMT"
},
"example": "Sat, 09 May 2020 09:24:58 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "84"
},
"example": "84"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/DataFilterByUrl-Device-IncorrectFieldsValue1"
},
"example": {
"errors": {
"error-type": "application",
"error-message": "'interface-name' not found"
}
}
}
}
}
},
"deprecated": false
}
},
"/operations/adtran-cloud-platform-uiworkflow:force-delete": {
"post": {
"tags": [
"Devices"
],
"summary": "Force Remove Device",
"description": "Attempts to `force delete` an exisiting device and its dependent children. Successful request returns the status of the operation, along with a transition id that can be used to verify the completion of the operation.\n\n\n \nRequest Payload Details\n\n\n\n\n|\tAttribute\t\t\t\t|\t\tDescription\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t|\n|---------------------------|------------------------------------------------------------------------------------------------|\n|\tdevice-name\t\t\t | **Required:** Name of the device.\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t|",
"operationId": "ForceRemoveDevice",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForceRemoveDeviceRequest"
},
"example": {
"input": {
"device-context": {
"device-name": "{{devices-extra-dev-name}}"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 26 Jun 2020 07:16:24 GMT"
},
"example": "Fri, 26 Jun 2020 07:16:24 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Vary": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
},
"example": "Accept-Encoding"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "gzip"
},
"example": "gzip"
}
}
}
},
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/ForceDeleteDevice-Success"
},
"example": {
"output": {
"trans-id": "b1524cbb-d054-4d9b-b246-550f67b1f31f",
"timestamp": "2020-06-26T07:16:24.560000",
"status": "force-deleting",
"completion-status": "in-progress"
}
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 26 Jun 2020 07:17:35 GMT"
},
"example": "Fri, 26 Jun 2020 07:17:35 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Vary": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
},
"example": "Accept-Encoding"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "gzip"
},
"example": "gzip"
}
}
}
},
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/ForceDeleteDevice-Failure1"
},
"example": {
"errors": {
"error-type": "rpc",
"error-tag": "Invalid input",
"error-message": "Expected message of form {\n One of [\n service-context : {\n service-id : \n }\n device-context : {\n device-name : \n }\n interface-context : {\n interface-name : \n }\n ]\n}"
}
}
}
}
}
},
"deprecated": false
}
},
"/operations/adtran-cloud-platform-uiworkflow:retrieve-compatible-model-names": {
"post": {
"tags": [
"Devices"
],
"summary": "Get All Compatible Model Names",
"description": "The compatible model-names API is used to retrieve the compatible model-names based on request model-name.\n\n \nRequest Payload Details\n\n\n\n| Attribute | Description |\n|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| input | Input model name |\n| model-name | **Required:** Part number of the device |",
"operationId": "GetAllCompatibleModelNames",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetAllCompatibleModelNamesRequest"
},
"example": {
"input": {
"model-name": "DPU"
}
}
}
},
"required": true
},
"responses": {
"default": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetAllCompatibleModelNames-Success"
},
"example": {
"output": {
"compatible-model-name": []
}
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-uiworkflow-interfaces:interfaces/interface=interface_1": {
"get": {
"tags": [
"Interfaces"
],
"summary": "Get Interface",
"description": "Fetches details of a specific interface mentioned in the url. Returns the data for a requested interface as described below.\n\n**Response Details**\n\n| Attribute | Description |\n|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| device-name | Name of upstream device with which the interface is associated. |\n| interface-type | Type of interface. |\n| state | The indicated state of the interface. For example state can be configured/deployed/activated. |\n| interface-name | A unique name for the interface. |\n| bundle-name | The bundle to associate with this interface. |\n| interface-id | A string that identifies the interface. |\n| subtended-device-name | Identifies the subtended host (e.g. TID) of this interface. |\n| lower-layer-interfaces | List of the lower layer interfaces (e.g. in an EFM group). |\n| profile-vector-name | Identifier of profile vector associated with this interface. |\n| number-of-lower-layer-interfaces | The number of interfaces layered configured for this interface. |",
"operationId": "GetInterface",
"parameters": [],
"responses": {
"404": {
"description": "Not Found",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 05 May 2020 10:58:58 GMT"
},
"example": "Tue, 05 May 2020 10:58:58 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "73"
},
"example": "73"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/GetInterface-IncorrectInterfaceName1"
},
"example": {
"errors": {
"error-type": "application",
"error-message": "'xyz' not found"
}
}
}
}
},
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 05 May 2020 10:56:35 GMT"
},
"example": "Tue, 05 May 2020 10:56:35 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "353"
},
"example": "353"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/GetInterface-Success"
},
"example": {
"device-name": "rooted-device",
"interface-type": "hundred-gigabit-ethernet",
"state": "activated",
"interface-name": "interface_1",
"bundle-name": "ChannelPartition",
"interface-id": "123",
"subtended-device-name": "",
"lower-layer-interfaces": [
"hundred-gigabit-ethernet 0/1"
],
"profile-vector-name": "ONU Eth UNI Profile Vector",
"number-of-lower-layer-interfaces": 0
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-uiworkflow-interfaces:interfaces/interface": {
"get": {
"tags": [
"Interfaces"
],
"summary": "Get All Interfaces",
"description": "Fetches list of all the interfaces in the MCP. Returns the data for a each interface as described below.\n\n**Response Details**\n\n| Attribute | Description |\n|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| device-name | Name of upstream device with which the interface is associated. |\n| interface-type | Type of interface. |\n| state | The indicated state of the interface. For example state can be configured/deployed/activated. |\n| interface-name | A unique name for the interface. |\n| bundle-name | The bundle to associate with this interface. |\n| interface-id | A string that identifies the interface. |\n| subtended-device-name | Identifies the subtended host (e.g. TID) of this interface. |\n| lower-layer-interfaces | List of the lower layer interfaces (e.g. in an EFM group). |\n| profile-vector-name | Identifier of profile vector associated with this interface. |\n| number-of-lower-layer-interfaces | The number of interfaces layered configured for this interface. |",
"operationId": "GetAllInterfaces",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 05 May 2020 10:53:36 GMT"
},
"example": "Tue, 05 May 2020 10:53:36 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "694"
},
"example": "694"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetAllInterfaces-Success"
},
"description": "",
"example": [
{
"device-name": "rooted-device",
"interface-type": "hundred-gigabit-ethernet",
"state": "activated",
"interface-name": "interface_1",
"bundle-name": "ChannelPartition",
"interface-id": "123",
"subtended-device-name": "",
"lower-layer-interfaces": [
"hundred-gigabit-ethernet 0/1"
],
"profile-vector-name": "ONU Eth UNI Profile Vector",
"number-of-lower-layer-interfaces": 0
},
{
"device-name": "rooted-device",
"interface-type": "ten-gigabit-ethernet",
"state": "activated",
"interface-name": "interface_2",
"bundle-name": "ChannelPartition",
"interface-id": "456",
"subtended-device-name": "",
"lower-layer-interfaces": [
"ten-gigabit-ethernet 0/1"
],
"profile-vector-name": "XPON Profile Vector",
"number-of-lower-layer-interfaces": 0
}
]
},
"example": [
{
"device-name": "rooted-device",
"interface-type": "hundred-gigabit-ethernet",
"state": "activated",
"interface-name": "interface_1",
"bundle-name": "ChannelPartition",
"interface-id": "123",
"subtended-device-name": "",
"lower-layer-interfaces": [
"hundred-gigabit-ethernet 0/1"
],
"profile-vector-name": "ONU Eth UNI Profile Vector",
"number-of-lower-layer-interfaces": 0
},
{
"device-name": "rooted-device",
"interface-type": "ten-gigabit-ethernet",
"state": "activated",
"interface-name": "interface_2",
"bundle-name": "ChannelPartition",
"interface-id": "456",
"subtended-device-name": "",
"lower-layer-interfaces": [
"ten-gigabit-ethernet 0/1"
],
"profile-vector-name": "XPON Profile Vector",
"number-of-lower-layer-interfaces": 0
}
]
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-uiworkflow-interfaces:interface-types/interface-type": {
"get": {
"tags": [
"Interfaces"
],
"summary": "Get All Interface Types",
"description": "Fetches information on types of interface in the system.\n\n**Response Details**\n\n| Attribute| Description |\n|---------|------------------|\n| interface-type | Interface type. Information on type of interface. |",
"operationId": "GetAllInterfaceTypes",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Thu, 07 May 2020 11:10:10 GMT"
},
"example": "Thu, 07 May 2020 11:10:10 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "365"
},
"example": "365"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetAllInterfaceType"
},
"description": "",
"example": [
{
"interface-type": "generic"
},
{
"interface-type": "hundred-gigabit-ethernet"
},
{
"interface-type": "ethernet"
},
{
"interface-type": "ten-gigabit-ethernet"
},
{
"interface-type": "virtual-ethernet"
},
{
"interface-type": "gigabit-ethernet"
},
{
"interface-type": "ngpon2"
},
{
"interface-type": "xgspon"
},
{
"interface-type": "gpon"
},
{
"interface-type": "lag-group"
},
{
"interface-type": "g-fast"
}
]
},
"example": [
{
"interface-type": "generic"
},
{
"interface-type": "hundred-gigabit-ethernet"
},
{
"interface-type": "ethernet"
},
{
"interface-type": "ten-gigabit-ethernet"
},
{
"interface-type": "virtual-ethernet"
},
{
"interface-type": "gigabit-ethernet"
},
{
"interface-type": "ngpon2"
},
{
"interface-type": "xgspon"
},
{
"interface-type": "gpon"
},
{
"interface-type": "lag-group"
},
{
"interface-type": "g-fast"
}
]
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-interfaces:interfaces/interface=DevInf_{test_uuid}": {
"get": {
"tags": [
"Inspect Interface"
],
"summary": "Query Interface",
"description": "Query the given interface. Inspect data is not included in the response to the general interace query. Since fetching data provided by inspect involves the communication with network elements, general queries omit the inspect tree for the sake of responsiveness.",
"operationId": "QueryInterface",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "Basic QURNSU46UEFTU1dPUkQ="
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"enum": [
"application/json"
],
"type": "string",
"example": "application/json"
}
},
{
"name": "test_uuid",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Mon, 30 Aug 2021 16:18:43 GMT"
},
"example": "Mon, 30 Aug 2021 16:18:43 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "\"df2503b4-58de-4df7-881e-4422cad589ac\""
},
"example": "\"df2503b4-58de-4df7-881e-4422cad589ac\""
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "private, no-cache"
},
"example": "private, no-cache"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
}
},
"content": {
"application/yang.data+json+firefly; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/QueryInterface"
},
"example": {
"subtended-device-names": [
"orchdev_d33ba51d-5e37-4dff-af10-077d137e00c8"
],
"device-name": "rooted-device",
"interface-type": "generic",
"state": "deployed",
"interface-name": "DevInf_d33ba51d-5e37-4dff-af10-077d137e00c8",
"interface-id": "",
"lower-layer-interfaces": [],
"profile-vector-name": "",
"number-of-lower-layer-interfaces": 0
}
}
}
}
},
"deprecated": false,
"security": []
}
},
"/data/adtran-cloud-platform-interfaces:interfaces/interface=DevInf_{test_uuid}/inspect": {
"get": {
"tags": [
"Inspect Interface"
],
"summary": "Query Interface Inspect",
"description": "Show all interface inspect items. This example is for informational purposes only. The output of this example will be different to support the solution specific data.",
"operationId": "QueryInterfaceInspect",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "Basic QURNSU46UEFTU1dPUkQ="
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"enum": [
"application/json"
],
"type": "string",
"example": "application/json"
}
},
{
"name": "test_uuid",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Mon, 30 Aug 2021 16:24:30 GMT"
},
"example": "Mon, 30 Aug 2021 16:24:30 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "\"153826fa-e546-4f5e-9238-22f45d2c5d24\""
},
"example": "\"153826fa-e546-4f5e-9238-22f45d2c5d24\""
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "private, no-cache"
},
"example": "private, no-cache"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
}
},
"content": {
"application/yang.data+json+firefly; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/QueryInterfaceInspect"
},
"example": {
"attached-gadgets": {
"gadgets-online": true,
"gadgets": [
"copter",
"cuffs"
]
},
"statistics": {
"in-broadcast-frames": "0",
"out-multicast-frames": "0",
"in-frames": "300",
"out-errors": "0",
"out-frames": "300",
"in-discards": "0",
"out-octets": "500",
"in-error-undersize-frames": "0",
"out-broadcast-frames": "1",
"in-error-oversize-frames": "0",
"in-multicast-frames": "0",
"out-discards": "0",
"in-error-fcs-frames": "0",
"in-errors": "0",
"in-octets": "500"
}
}
}
}
}
},
"deprecated": false,
"security": []
}
},
"/data/adtran-cloud-platform-interfaces:interfaces/interface=DevInf_{test_uuid}/inspect/attached-gadgets": {
"get": {
"tags": [
"Inspect Interface"
],
"summary": "Query Interface Inspect attached-gadgets",
"description": "Show interface inspect subtree items. This example is for informational purposes only.\nFor actual applications this would be replaced with solution specific data paths.",
"operationId": "QueryInterfaceInspectattached-gadgets",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "Basic QURNSU46UEFTU1dPUkQ="
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"enum": [
"application/json"
],
"type": "string",
"example": "application/json"
}
},
{
"name": "test_uuid",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 27 Aug 2021 18:35:06 GMT"
},
"example": "Fri, 27 Aug 2021 18:35:06 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "\"3092fd66-2a17-4e3c-8ba8-ebcc6332e7b7\""
},
"example": "\"3092fd66-2a17-4e3c-8ba8-ebcc6332e7b7\""
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "private, no-cache"
},
"example": "private, no-cache"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
}
},
"content": {
"application/yang.data+json+firefly; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/QueryInterfaceInspectattached-gadgets"
},
"example": {
"gadgets-online": true,
"gadgets": [
"copter",
"cuffs"
]
}
}
}
}
},
"deprecated": false,
"security": []
}
},
"/data/adtran-cloud-platform-devices:devices/device=orchdev_{test_uuid}": {
"get": {
"tags": [
"Inspect Device"
],
"summary": "Query Device",
"description": "Query the given device. Inspect data is not included in the response to the general device query. Since fetching data provided by inspect involves the communication with network elements, general queries omit the inspect tree for the sake of responsiveness.",
"operationId": "QueryDevice",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "Basic QURNSU46UEFTU1dPUkQ="
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"enum": [
"application/json"
],
"type": "string",
"example": "application/json"
}
},
{
"name": "test_uuid",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Mon, 30 Aug 2021 16:19:16 GMT"
},
"example": "Mon, 30 Aug 2021 16:19:16 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "\"a950d461-3497-47bc-8c22-64c3aa9fc2c6\""
},
"example": "\"a950d461-3497-47bc-8c22-64c3aa9fc2c6\""
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "private, no-cache"
},
"example": "private, no-cache"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
}
},
"content": {
"application/yang.data+json+firefly; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/QueryDevice"
},
"example": {
"device-name": "orchdev_d33ba51d-5e37-4dff-af10-077d137e00c8",
"state": "deployed",
"management-domain": "",
"base-configuration": "",
"part-number": "GENERIC",
"metadata": {
"event-config": {
"event": []
}
},
"profile-vector-name": "",
"model-name": "Generic Device"
}
}
}
}
},
"deprecated": false,
"security": []
}
},
"/data/adtran-cloud-platform-devices:devices/device=orchdev_{test_uuid}/inspect": {
"get": {
"tags": [
"Inspect Device"
],
"summary": "Query Device Inspect",
"description": "Show all device inspect items. This example is for informational purposes only. The output of this example will be different to support the solution specific data.",
"operationId": "QueryDeviceInspect",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "Basic QURNSU46UEFTU1dPUkQ="
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"enum": [
"application/json"
],
"type": "string",
"example": "application/json"
}
},
{
"name": "test_uuid",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Mon, 30 Aug 2021 16:24:25 GMT"
},
"example": "Mon, 30 Aug 2021 16:24:25 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "\"ac01ee13-fc32-4e7c-9f0e-cbfe0610e3a6\""
},
"example": "\"ac01ee13-fc32-4e7c-9f0e-cbfe0610e3a6\""
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "private, no-cache"
},
"example": "private, no-cache"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
}
},
"content": {
"application/yang.data+json+firefly; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/QueryDeviceInspect"
},
"example": {
"gadget-info": {
"gadget-type": "copter",
"max-speed": 30,
"max-altitude": 10,
"nested-usage": [
{
"interval": 0,
"deployed-count": 1,
"error-count": 1
},
{
"interval": 1,
"deployed-count": 3,
"error-count": 2
},
{
"interval": 2,
"deployed-count": 5,
"error-count": 3
},
{
"interval": 3,
"deployed-count": 7,
"error-count": 4
},
{
"interval": 4,
"deployed-count": 9,
"error-count": 5
}
]
},
"gadget-usage": {
"historic": [
{
"day": 1,
"deployed-count": 3,
"error-count": 2
},
{
"day": 2,
"deployed-count": 5,
"error-count": 3
},
{
"day": 3,
"deployed-count": 7,
"error-count": 4
},
{
"day": 4,
"deployed-count": 9,
"error-count": 5
},
{
"day": 5,
"deployed-count": 11,
"error-count": 6
},
{
"day": 6,
"deployed-count": 13,
"error-count": 7
},
{
"day": 7,
"deployed-count": 15,
"error-count": 8
}
],
"current": {
"deployed-count": 5,
"error-count": 0
}
},
"status": {
"online": true
}
}
}
}
}
},
"deprecated": false,
"security": []
}
},
"/data/adtran-cloud-platform-devices:devices/device=orchdev_{test_uuid}/inspect/gadget-info": {
"get": {
"tags": [
"Inspect Device"
],
"summary": "Query Device Inspect Gadget-info",
"description": "Show device inspect subtree items. This example is for informational purposes only.\nFor actual applications this would be replaced with solution specific data paths.",
"operationId": "QueryDeviceInspectGadget-info",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "Basic QURNSU46UEFTU1dPUkQ="
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"enum": [
"application/json"
],
"type": "string",
"example": "application/json"
}
},
{
"name": "test_uuid",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Mon, 30 Aug 2021 16:22:39 GMT"
},
"example": "Mon, 30 Aug 2021 16:22:39 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "\"54754113-3028-455a-82fb-9c9754630278\""
},
"example": "\"54754113-3028-455a-82fb-9c9754630278\""
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "private, no-cache"
},
"example": "private, no-cache"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
}
},
"content": {
"application/yang.data+json+firefly; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/QueryDeviceInspectGadget-info"
},
"example": {
"gadget-type": "copter",
"max-speed": 30,
"max-altitude": 10,
"nested-usage": [
{
"interval": 0,
"deployed-count": 1,
"error-count": 1
},
{
"interval": 1,
"deployed-count": 3,
"error-count": 2
},
{
"interval": 2,
"deployed-count": 5,
"error-count": 3
},
{
"interval": 3,
"deployed-count": 7,
"error-count": 4
},
{
"interval": 4,
"deployed-count": 9,
"error-count": 5
}
]
}
}
}
}
},
"deprecated": false,
"security": []
}
},
"/data/adtran-cloud-platform-devices:devices/device=orchdev_{test_uuid}/inspect/gadget-usage": {
"get": {
"tags": [
"Inspect Device"
],
"summary": "Query Device Inspect Gadget-usage",
"description": "Show device inspect subtree items. This example is for informational purposes only.\nFor actual applications this would be replaced with solution specific data paths.",
"operationId": "QueryDeviceInspectGadget-usage",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "Basic QURNSU46UEFTU1dPUkQ="
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"enum": [
"application/json"
],
"type": "string",
"example": "application/json"
}
},
{
"name": "test_uuid",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Mon, 30 Aug 2021 16:22:50 GMT"
},
"example": "Mon, 30 Aug 2021 16:22:50 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "\"77f9a421-0184-48d9-8169-98691a61dac7\""
},
"example": "\"77f9a421-0184-48d9-8169-98691a61dac7\""
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "private, no-cache"
},
"example": "private, no-cache"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
}
},
"content": {
"application/yang.data+json+firefly; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/QueryDeviceInspectGadget-usage"
},
"example": {
"historic": [
{
"day": 1,
"deployed-count": 3,
"error-count": 2
},
{
"day": 2,
"deployed-count": 5,
"error-count": 3
},
{
"day": 3,
"deployed-count": 7,
"error-count": 4
},
{
"day": 4,
"deployed-count": 9,
"error-count": 5
},
{
"day": 5,
"deployed-count": 11,
"error-count": 6
},
{
"day": 6,
"deployed-count": 13,
"error-count": 7
},
{
"day": 7,
"deployed-count": 15,
"error-count": 8
}
],
"current": {
"deployed-count": 5,
"error-count": 0
}
}
}
}
}
},
"deprecated": false,
"security": []
}
},
"/data/adtran-cloud-platform-management-domains:management-domains/management-domain=Management-Domain": {
"get": {
"tags": [
"Management Domain"
],
"summary": "Get Management Domain",
"description": "Gets `Management Domain` from Management Domain Name. Returns the data for a requested Management Domain as described below.\n\n**Response Details**\n\n| Attribute | Description |\n|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| management-domain-name | Unique name of the management-domain the user wishes to assign for personalization in their management system.Possible Values: string with length 1..250 |\n| persistency-server | Unique persistency server name. |\n| dhcp-ipv4-server | The unique DHCP IPv4 server name. This is only applicable for management domains which are of type 'management-domain-dhcp-ipv4'. |\n| gateway | This is only applicable for management domains which are of type 'management-domain-dhcp-ipv4'. Address of a gateway for the subnet. Posssible Formats: ipv4-address |\n| subnet | The routing prefix of the subnet represented by this IPv4 address pool. eg. `128.66.0.0/24`.|\n| first-address | The first IP address in the range. Posssible Formats: ipv4-address. |\n| last-address | The last IP address in the range. Posssible Formats: ipv4-address. |\n|\tmanagement-domain-type\t\t\t| Management domain type. Possible Values: management-domain-static-ipv4, management-domain-external, management-domain-dhcp-ipv4.\t\t\t\t\t\t\t\t\t\t\t|\n|\tstate\t\t| Current state of the content provider. Possible Values: configured, deployed, activated\t\t\t\t\t\t\t\t\t|\n|\tdhcp-ipv4-pool\t\t| DHCP pool configuration parameters. Containing Values: first-address, last-address, subnet, gateway\t\t\t\t\t\t\t\t\t|\n|\tcredentials-name\t\t|\tName of credentials resource.\t\t\t\t\t\t\t\t\t|\n| management-vlan-outer-tag | Outer VLAN tag for management domain. Posssible Values: untagged or 0..4094 |\n| management-vlan-inner-tag | Inner VLAN tag for management domain. Posssible Values: none or 0..4094 |",
"operationId": "GetManagementDomain",
"parameters": [],
"responses": {
"404": {
"description": "Not Found",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Wed, 06 May 2020 12:01:42 GMT"
},
"example": "Wed, 06 May 2020 12:01:42 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "136"
},
"example": "136"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/GetManagementDomain-IncorrectManagementDomainName1"
},
"example": {
"message": "Could not find path List(adtran-cloud-platform-management-domains, management-domains, management-domain=InvalidName)"
}
}
}
},
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Wed, 06 May 2020 12:01:17 GMT"
},
"example": "Wed, 06 May 2020 12:01:17 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "426"
},
"example": "426"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "private, no-cache"
},
"example": "private, no-cache"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "\"83f10196-c10f-44fe-948b-331409ec851c\""
},
"example": "\"83f10196-c10f-44fe-948b-331409ec851c\""
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/yang.data+json+firefly; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/GetManagementDomain-Success"
},
"example": {
"management-domain-type": "management-domain-dhcp-ipv4",
"state": "activated",
"dhcp": {
"server-name": [
"DHCP Server"
],
"dhcp-ipv4-pool": {
"first-address": "1.1.1.1",
"last-address": "5.5.5.5",
"gateway": "2.2.2.2",
"subnet": "128.66.0.0/24"
}
},
"management-vlan-outer-tag": "untagged",
"management-domain-name": "Management-Domain",
"management-vlan-inner-tag": "none",
"credentials-name": "Credentials",
"persistency-server": [
"Persistency Server"
]
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-management-domains:management-domains/management-domain": {
"get": {
"tags": [
"Management Domain"
],
"summary": "Get All Management Domain",
"description": "Get details of all `Management Domain`. Returns the data for a requested Management Domain as described below.\n\n**Response Details**\n\n| Attribute | Description |\n|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| management-domain-name | Unique name of the management-domain the user wishes to assign for personalization in their management system.Possible Values: string with length 1..250 |\n| persistency-server | Unique persistency server name. |\n| dhcp-ipv4-server | The unique DHCP IPv4 server name. This is only applicable for management domains which are of type 'management-domain-dhcp-ipv4'. |\n| gateway | This is only applicable for management domains which are of type 'management-domain-dhcp-ipv4'. Address of a gateway for the subnet. Posssible Formats: ipv4-address |\n| subnet | The routing prefix of the subnet represented by this IPv4 address pool. eg. `128.66.0.0/24`.|\n| first-address | The first IP address in the range. Posssible Formats: ipv4-address |\n| last-address | The last IP address in the range. Posssible Formats: ipv4-address |\n|\tmanagement-domain-type\t\t\t| Management domain type. Possible Values: management-domain-static-ipv4, management-domain-external, management-domain-dhcp-ipv4\t\t\t\t\t\t\t\t\t\t\t|\n|\tstate\t\t| Current state of the content provider. Possible Values: configured, deployed, activated\t\t\t\t\t\t\t\t\t|\n|\tdhcp-ipv4-pool\t\t| DHCP pool configuration parameters. Containing Values: first-address, last-address, subnet, gateway\t\t\t\t\t\t\t\t\t|\n|\tcredentials-name\t\t|\tName of credentials resource.\t\t\t\t\t\t\t\t\t|\n| management-vlan-outer-tag | Outer VLAN tag for management domain. Posssible Values: untagged or 0..4094 |\n| management-vlan-inner-tag | Inner VLAN tag for management domain. Posssible Values: none or 0..4094 |",
"operationId": "GetAllManagementDomain",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Wed, 06 May 2020 11:59:52 GMT"
},
"example": "Wed, 06 May 2020 11:59:52 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "428"
},
"example": "428"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "private, no-cache"
},
"example": "private, no-cache"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "\"e1fd4921-c0df-480a-a571-fd05dd4e11b3\""
},
"example": "\"e1fd4921-c0df-480a-a571-fd05dd4e11b3\""
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/yang.data+json+firefly; charset=UTF-8": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetAllManagementDomain-Success"
},
"description": "",
"example": [
{
"management-domain-type": "management-domain-dhcp-ipv4",
"state": "activated",
"dhcp": {
"server-name": [
"DHCP Server"
],
"dhcp-ipv4-pool": {
"first-address": "1.1.1.1",
"last-address": "5.5.5.5",
"gateway": "2.2.2.2",
"subnet": "128.66.0.0/24"
}
},
"management-vlan-outer-tag": "untagged",
"management-domain-name": "Management-Domain",
"management-vlan-inner-tag": "none",
"credentials-name": "Credentials",
"persistency-server": [
"Persistency Server"
]
}
]
},
"example": [
{
"management-domain-type": "management-domain-dhcp-ipv4",
"state": "activated",
"dhcp": {
"server-name": [
"DHCP Server"
],
"dhcp-ipv4-pool": {
"first-address": "1.1.1.1",
"last-address": "5.5.5.5",
"gateway": "2.2.2.2",
"subnet": "128.66.0.0/24"
}
},
"management-vlan-outer-tag": "untagged",
"management-domain-name": "Management-Domain",
"management-vlan-inner-tag": "none",
"credentials-name": "Credentials",
"persistency-server": [
"Persistency Server"
]
}
]
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-uiworkflow-management-domains:management-domain-types/management-domain-type": {
"get": {
"tags": [
"Management Domain"
],
"summary": "Get All Management Domain Types",
"description": "Fetches list of management domain types.\n\n**Response Details**\n\n| Attribute| Description |\n|---------|------------------|\n| management-domain-type | The stated label of the management domain type. |\n|management-domain-context|The name of the field ID to use during a device create. This field is the management domain type.|\n|configurable |If true, the management domain supports the configure RPC.|",
"operationId": "GetAllManagementDomainTypes",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Thu, 07 May 2020 11:39:26 GMT"
},
"example": "Thu, 07 May 2020 11:39:26 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "383"
},
"example": "383"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/GetAllManagementDomainTypes"
},
"example": {
"management-domain-type": [
{
"management-domain-type": "static-ip",
"management-domain-context": "management-domain-static-ip",
"configurable": false
},
{
"management-domain-type": "static-ipv4",
"management-domain-context": "management-domain-static-ipv4",
"configurable": false
},
{
"management-domain-type": "external",
"management-domain-context": "management-domain-external",
"configurable": false
},
{
"management-domain-type": "dhcp-ipv4",
"management-domain-context": "management-domain-dhcp-ipv4",
"configurable": true
}
]
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-uiworkflow-servers:servers/server=Server": {
"get": {
"tags": [
"Servers"
],
"summary": "Get Server",
"description": "Fetches details of a `server` by Server Name. Returns the data for a requested server as described below.\n\n**Response Details**\n\n| Attribute | Description |\n|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| server-name | Name of server. Possible Values: string of length 1..250 |\n| type | Selected types supported by this server. |\n| credentials-name | Name of credentials resource. |\n| host-ip | Host IP address. Posssible Formats: ipv4-address and ipv6 address |\n| port | Port Number. Posssible Values: 1..65535 |\n| base-path | Base file path used when retrieving files. |\n|\tstate\t\t| Current state of the content provider. Possible Values: configured, deployed, activated\t\t\t\t\t\t\t\t\t|\n| data-center-name | Name of data center.",
"operationId": "GetServer",
"parameters": [],
"responses": {
"404": {
"description": "Not Found",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Wed, 06 May 2020 08:49:02 GMT"
},
"example": "Wed, 06 May 2020 08:49:02 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "83"
},
"example": "83"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/GetServer-IncorrectServerNotExists1"
},
"example": {
"errors": {
"error-type": "application",
"error-message": "'InvalidServer' not found"
}
}
}
}
},
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Wed, 06 May 2020 07:05:20 GMT"
},
"example": "Wed, 06 May 2020 07:05:20 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "188"
},
"example": "188"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/GetServer-Success"
},
"example": {
"host-ip": "10.11.11.11",
"state": "activated",
"server-name": "Server",
"data-center-name": "Data Center",
"port": "1",
"base-path": "/home/adtran",
"type": [
"TFTP"
],
"credentials-name": "Credentials"
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-uiworkflow-servers:servers/server": {
"get": {
"tags": [
"Servers"
],
"summary": "Get All Servers",
"description": "Fetches details of all Servers. Returns the data for a requested server as described below.\n\n**Response Details**\n\n| Attribute | Description |\n|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| server-name | Name of server. Possible Values: string of length 1..250 |\n| type | Selected types supported by this server. |\n| credentials-name | Name of credentials resource. |\n| host-ip | Host IP address. |\n| port | Port Number. Posssible Values: 1..65535 |\n| base-path | Base file path used when retrieving files. |\n| data-center-name | Name of data center. |\n|\tstate\t\t| Current state of the content provider. Possible Values: configured, deployed, activated\t\t\t\t\t\t\t\t\t|",
"operationId": "GetAllServers",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Wed, 06 May 2020 07:10:56 GMT"
},
"example": "Wed, 06 May 2020 07:10:56 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "190"
},
"example": "190"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetAllServers-Success"
},
"description": "",
"example": [
{
"host-ip": "10.11.11.11",
"state": "activated",
"server-name": "Server",
"data-center-name": "Data Center",
"port": "1",
"base-path": "/home/adtran",
"type": [
"TFTP"
],
"credentials-name": "Credentials"
}
]
},
"example": [
{
"host-ip": "10.11.11.11",
"state": "activated",
"server-name": "Server",
"data-center-name": "Data Center",
"port": "1",
"base-path": "/home/adtran",
"type": [
"TFTP"
],
"credentials-name": "Credentials"
}
]
}
}
}
},
"deprecated": false
}
},
"/operations/adtran-captive-portal-services:find-services": {
"post": {
"tags": [
"Services"
],
"summary": "Find Services",
"description": "This RPC can be used to search for a services that satisfy the given search parameters. A list of all matching service IDs will be returned.\n\n \nRequest Payload Details\n\n\n|\tAttribute\t\t\t\t|\tDescription\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t|\n|---------------------------|------------------------------------------------------------------------------------------------|\n|\tuplink-endpoint\t\t| One end of the service. Some services may not discriminate between uplink and downlink - these terms are used for clarity in identifying direction.\t\t\t\t\t\t\t\t|\n|\tdownlink-endpoint\t\t|\tOne end of the service. Some services may not discriminate between uplink and downlink - these terms are used for clarity in identifying direction.\t\t\t\t\t\t\t|\n|\tinterface-endpoint\t\t|\tAn endpoint defined by an interface an 0, 1, or 2 VLANs.\t\t\t\t\t\t\t|\n|\touter-tag-vlan-id\t\t|\tThe service endpoint outer VLAN tag. Untagged traffic will use the value of 'untagged'. Default Value: untagged\tPossible Values: untagged, any (Use any VLAN ID between a valid range of 1 to 4094 for tagged traffic) or uint16 in range 0..4094\t\t\t\t\t\t|\n|\tinner-tag-vlan-id\t\t|\tThe inner tag only applies when the outer tag is a specified VLAN ID. The service endpoint inner VLAN tag. A value of 'none' indicates there is no inner tag. Default Value: none\tPossible Values: none or uint16 in range 0..4094\t\t\t\t\t\t|\n|\tservice-type\t\t|\tThe type of service. This can affect the way in which the service will be created in the network\t\t\t\t\t\t|",
"operationId": "FindServices",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FindServicesRequest"
},
"example": {
"input": {
"uplink-endpoint": {
"interface-endpoint": {
"device-name": "PON-Blade-1",
"interface-id": "1",
"outer-tag-vlan-id": 227,
"inner-tag-vlan-id": 2257
}
},
"downlink-endpoint": {
"interface-endpoint": {
"device-name": "ONU-1",
"interface-id": "virtual-ethernet 0/1"
}
},
"service-type": ""
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Thu, 07 May 2020 11:10:22 GMT"
},
"example": "Thu, 07 May 2020 11:10:22 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "36"
},
"example": "36"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/FindServices-Success"
},
"example": {
"output": {
"service": [
"Service"
]
}
}
}
}
}
},
"deprecated": false
}
},
"/operations/adtran-cloud-platform-uiworkflow:suspend": {
"post": {
"tags": [
"Services"
],
"summary": "Suspend Service",
"description": "Attempts to transition an exisiting Service State from `in-service` to `suspended` state.\n\n \nRequest Payload Details\n\n\n|\tAttribute\t\t\t\t|\tDescription\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t|\n|---------------------------|------------------------------------------------------------------------------------------------|\n|\tservice-id\t\t\t| **Required:** Name of the service. Possible Values: string of length 1..250\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t|",
"operationId": "SuspendService",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuspendServiceRequest"
},
"example": {
"input": {
"service-context": {
"service-id": "Service"
}
}
}
}
},
"required": true
},
"responses": {
"default": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuspendService-IncorrectServiceNotExists"
},
"example": {
"errors": {
"error-type": "rpc",
"error-tag": "Validation of precondition failed",
"error-message": "Service InvalidService does not exist"
}
}
}
}
}
},
"deprecated": false
}
},
"/operations/adtran-cloud-platform-uiworkflow:resume": {
"post": {
"tags": [
"Services"
],
"summary": "Resume Service",
"description": "Attempts to transition an exisiting Service State from `suspended` to `in-service` state.\n\n \nRequest Payload Details\n\n\n|\tAttribute\t\t\t\t|\tDescription\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t|\n|---------------------------|------------------------------------------------------------------------------------------------|\n|\tservice-id\t\t\t| **Required:** Name of the service. Possible Values: string of length 1..250\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t|",
"operationId": "ResumeService",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResumeServiceRequest"
},
"example": {
"input": {
"service-context": {
"service-id": "Service"
}
}
}
}
},
"required": true
},
"responses": {
"default": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResumeService-Success"
},
"example": {
"output": {
"timestamp": "2020-05-07T08:08:28.726000",
"service-id": "Service",
"status": "resuming",
"trans-id": "5a167a40-c2d8-4a29-8388-0a8f201e39d1",
"completion-status": "in-progress"
}
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-uiworkflow-services:services/service=Service": {
"get": {
"tags": [
"Services"
],
"summary": "Get Service",
"description": "Gets a `Service` by Service Name.\n\n**Response Details**\n\n|\tAttribute\t\t\t\t|\tDescription\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t|\n|---------------------------|------------------------------------------------------------------------------------------------|\n|\tservice-id\t\t\t| Name of the service. Possible Values: string of length 1..250\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t|\n|\tuplink-endpoint\t\t| One end of the service. Some services may not discriminate between uplink and downlink - these terms are used for clarity in identifying direction.\t\t\t\t\t\t\t\t|\n|\tdownlink-endpoint\t\t|\tOne end of the service. Some services may not discriminate between uplink and downlink - these terms are used for clarity in identifying direction.\t\t\t\t\t\t\t|\n|\tinterface-endpoint\t\t|\tAn endpoint defined by an interface an 0, 1, or 2 VLANs.\t\t\t\t\t\t\t|\n|\tcontent-provider-name\t\t|\tThe name of the content provider for the endpoint.\t\t\t\t\t\t\t|\n|\touter-tag-vlan-id\t\t|\tThe service endpoint outer VLAN tag. Untagged traffic will use the value of 'untagged'. Default Value: untagged\tPossible Values: untagged, any (Use any VLAN ID between a valid range of 1 to 4094 for tagged traffic) or uint16 in range 0..4094\t\t\t\t\t\t|\n|\tinner-tag-vlan-id\t\t|\tThe inner tag only applies when the outer tag is a specified VLAN ID. The service endpoint inner VLAN tag. A value of 'none' indicates there is no inner tag. Default Value: none\tPossible Values: none or uint16 in range 0..4094\t\t\t\t\t\t|\n|\tipv4-address\t\t|The IPv4 address for the subscriber.\tPossible Formats: none or uint16 in range 0..4094\t\t\t\t\t\t|\n|\tinterface-name\t\t|The name of the interface for the endpoint.\t\t\t\t\t\t|\n|\tstate\t\t| Current state of the content provider. Possible Values: configured, deployed, activated\t\t\t\t\t\t\t\t\t|\n|\tservice-type\t\t| The type of service. This can affect the way in which the service will be created in the network.\t\t\t\t\t\t\t\t\t|\n|\tdown-sla\t\t| The Service Level Agreement to apply to the service in the uplink-to-downlink direction.\t\t\t\t\t\t\t\t\t|\n|\tup-sla\t\t| The Service Level Agreement to apply to the service in the downlink-to-uplink direction.\t\t\t\t\t\t\t\t|\n|\tdevice-name\t\t| The sysname of the device hosting the interface.\t\t\t\t\t\t\t\t|",
"operationId": "GetService",
"parameters": [],
"responses": {
"404": {
"description": "Not Found",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Thu, 07 May 2020 09:47:13 GMT"
},
"example": "Thu, 07 May 2020 09:47:13 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "84"
},
"example": "84"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/GetService-IncorrectServiceNotExists1"
},
"example": {
"errors": {
"error-type": "application",
"error-message": "'InvalidService' not found"
}
}
}
}
},
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Thu, 07 May 2020 09:44:49 GMT"
},
"example": "Thu, 07 May 2020 09:44:49 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "803"
},
"example": "803"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/GetService-Success"
},
"example": {
"success": "true",
"timestamp": "2020-05-07T09:44:49.020Z",
"state": "activated",
"service-type": "",
"minor-code": "",
"major-code": "none",
"error-description": "",
"profile-name": "SDX Service1 100M",
"down-sla": "",
"service-id": "Service",
"up-sla": "",
"status": "activated",
"uplink-endpoint": {
"interface-endpoint": {
"device-name": "PON-Blade-1",
"outer-tag-vlan-id": 227,
"interface-name": "PON-Blade-1-Provider-Interface",
"ipv4-address": "2.2.2.2",
"interface-id": "1",
"content-provider-name": "Content-Provider",
"inner-tag-vlan-id": 2257
}
},
"downlink-endpoint": {
"interface-endpoint": {
"device-name": "ONU-1",
"outer-tag-vlan-id": "untagged",
"interface-name": "ONU-1-to-Subscriber",
"ipv4-address": "3.3.3.3",
"interface-id": "virtual-ethernet 0/1",
"inner-tag-vlan-id": "none"
}
},
"remote-id": "12",
"content-provider-name": "Content-Provider"
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-uiworkflow-services:service-profiles/service-profile": {
"get": {
"tags": [
"Services"
],
"summary": "Get Service Profiles",
"description": "Fetches information of profiles being used for service configuration.\n\n**Response Details**\n\n| Attribute| Description |\n|---------|------------------|\n| service-profile-name | The profile to associate with this service. |\n| service-type \t| The type of service. This can affect the way in which the service will be created in the network. |\n| down-sla | The Service Level Agreement to apply to the service in the uplink-to-downlink direction. |\n| up-sla | The Service Level Agreement to apply to the service in the downlink-to-uplink direction.|",
"operationId": "GetServiceProfiles",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Thu, 07 May 2020 10:37:35 GMT"
},
"example": "Thu, 07 May 2020 10:37:35 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "2071"
},
"example": "2071"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetServiceProfile"
},
"description": "",
"example": [
{
"service-profile-name": "LCI Service Profile Vector",
"service-type": "data",
"up-sla": "",
"down-sla": ""
},
{
"service-profile-name": "Residential Data Service",
"service-type": "data",
"up-sla": "",
"down-sla": ""
},
{
"service-profile-name": "Residential Video Service",
"service-type": "data",
"up-sla": "",
"down-sla": ""
},
{
"service-profile-name": "SDX Service1 100M",
"service-type": "data",
"up-sla": "",
"down-sla": ""
},
{
"service-profile-name": "SDX Service1 100M DHCP",
"service-type": "data",
"up-sla": "",
"down-sla": ""
},
{
"service-profile-name": "SDX Service1 100M PPPoE",
"service-type": "data",
"up-sla": "",
"down-sla": ""
},
{
"service-profile-name": "SDX Service1 Enable AES 100M",
"service-type": "data",
"up-sla": "",
"down-sla": ""
},
{
"service-profile-name": "SDX Service2 100M",
"service-type": "data",
"up-sla": "",
"down-sla": ""
},
{
"service-profile-name": "SDX Service2 100M ANCP",
"service-type": "data",
"up-sla": "",
"down-sla": ""
},
{
"service-profile-name": "SDX Service2 100M DHCP",
"service-type": "data",
"up-sla": "",
"down-sla": ""
},
{
"service-profile-name": "SDX Service2 100M DHCP and ANCP",
"service-type": "data",
"up-sla": "",
"down-sla": ""
},
{
"service-profile-name": "SDX Service2 100M PPPoE",
"service-type": "data",
"up-sla": "",
"down-sla": ""
},
{
"service-profile-name": "SDX Service2 100M PPPoE and ANCP",
"service-type": "data",
"up-sla": "",
"down-sla": ""
},
{
"service-profile-name": "SDX Service2 Scheduler",
"service-type": "data",
"up-sla": "",
"down-sla": ""
},
{
"service-profile-name": "SDX Service3 500M",
"service-type": "data",
"up-sla": "",
"down-sla": ""
},
{
"service-profile-name": "SDX Service3 500M DHCP",
"service-type": "data",
"up-sla": "",
"down-sla": ""
},
{
"service-profile-name": "SDX Service3 500M PPPoE",
"service-type": "data",
"up-sla": "",
"down-sla": ""
},
{
"service-profile-name": "SDX Service3 Scheduler",
"service-type": "data",
"up-sla": "",
"down-sla": ""
},
{
"service-profile-name": "SDX Service4 1G",
"service-type": "data",
"up-sla": "",
"down-sla": ""
},
{
"service-profile-name": "SDX Service4 1G DHCP",
"service-type": "data",
"up-sla": "",
"down-sla": ""
},
{
"service-profile-name": "SDX Service4 1G PPPoE",
"service-type": "data",
"up-sla": "",
"down-sla": ""
}
]
},
"example": [
{
"service-profile-name": "LCI Service Profile Vector",
"service-type": "data",
"up-sla": "",
"down-sla": ""
},
{
"service-profile-name": "Residential Data Service",
"service-type": "data",
"up-sla": "",
"down-sla": ""
},
{
"service-profile-name": "Residential Video Service",
"service-type": "data",
"up-sla": "",
"down-sla": ""
},
{
"service-profile-name": "SDX Service1 100M",
"service-type": "data",
"up-sla": "",
"down-sla": ""
},
{
"service-profile-name": "SDX Service1 100M DHCP",
"service-type": "data",
"up-sla": "",
"down-sla": ""
},
{
"service-profile-name": "SDX Service1 100M PPPoE",
"service-type": "data",
"up-sla": "",
"down-sla": ""
},
{
"service-profile-name": "SDX Service1 Enable AES 100M",
"service-type": "data",
"up-sla": "",
"down-sla": ""
},
{
"service-profile-name": "SDX Service2 100M",
"service-type": "data",
"up-sla": "",
"down-sla": ""
},
{
"service-profile-name": "SDX Service2 100M ANCP",
"service-type": "data",
"up-sla": "",
"down-sla": ""
},
{
"service-profile-name": "SDX Service2 100M DHCP",
"service-type": "data",
"up-sla": "",
"down-sla": ""
},
{
"service-profile-name": "SDX Service2 100M DHCP and ANCP",
"service-type": "data",
"up-sla": "",
"down-sla": ""
},
{
"service-profile-name": "SDX Service2 100M PPPoE",
"service-type": "data",
"up-sla": "",
"down-sla": ""
},
{
"service-profile-name": "SDX Service2 100M PPPoE and ANCP",
"service-type": "data",
"up-sla": "",
"down-sla": ""
},
{
"service-profile-name": "SDX Service2 Scheduler",
"service-type": "data",
"up-sla": "",
"down-sla": ""
},
{
"service-profile-name": "SDX Service3 500M",
"service-type": "data",
"up-sla": "",
"down-sla": ""
},
{
"service-profile-name": "SDX Service3 500M DHCP",
"service-type": "data",
"up-sla": "",
"down-sla": ""
},
{
"service-profile-name": "SDX Service3 500M PPPoE",
"service-type": "data",
"up-sla": "",
"down-sla": ""
},
{
"service-profile-name": "SDX Service3 Scheduler",
"service-type": "data",
"up-sla": "",
"down-sla": ""
},
{
"service-profile-name": "SDX Service4 1G",
"service-type": "data",
"up-sla": "",
"down-sla": ""
},
{
"service-profile-name": "SDX Service4 1G DHCP",
"service-type": "data",
"up-sla": "",
"down-sla": ""
},
{
"service-profile-name": "SDX Service4 1G PPPoE",
"service-type": "data",
"up-sla": "",
"down-sla": ""
}
]
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-services:services": {
"get": {
"tags": [
"Services"
],
"summary": "Get Services",
"description": "Fetches list of all the services in the MCP. Returns the data for each service as described below.\n\n**Response Details**\n\n| Attribute | Description |\n| --- | --- |\n| service-id | Name of the service. Possible Values: string of length 1..250 |\n| uplink-endpoint | One end of the service. Some services may not discriminate between uplink and downlink - these terms are used for clarity in identifying direction. |\n| downlink-endpoint | One end of the service. Some services may not discriminate between uplink and downlink - these terms are used for clarity in identifying direction. |\n| interface-endpoint | An endpoint defined by an interface an 0, 1, or 2 VLANs. |\n| content-provider-name | The name of the content provider for the endpoint. |\n| outer-tag-vlan-id | The service endpoint outer VLAN tag. Untagged traffic will use the value of 'untagged'. Default Value: untagged Possible Values: untagged, any (Use any VLAN ID between a valid range of 1 to 4094 for tagged traffic) or uint16 in range 0..4094 |\n| inner-tag-vlan-id | The inner tag only applies when the outer tag is a specified VLAN ID. The service endpoint inner VLAN tag. A value of 'none' indicates there is no inner tag. Default Value: none Possible Values: none or uint16 in range 0..4094 |\n| ipv4-address | The IPv4 address for the subscriber. Possible Formats: none or uint16 in range 0..4094 |\n| interface-name | The name of the interface for the endpoint. |\n| state | Current state of the content provider. Possible Values: configured, deployed, activated |\n| service-type | The type of service. This can affect the way in which the service will be created in the network. |\n| down-sla | The Service Level Agreement to apply to the service in the uplink-to-downlink direction. |\n| up-sla | The Service Level Agreement to apply to the service in the downlink-to-uplink direction. |\n| device-name | The sysname of the device hosting the interface. |\n| remote-id | The remote ID associated with the service. |\n| agent-circuit-id | The agent circuit ID associated with the service. |",
"operationId": "GetServices",
"parameters": [],
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"deprecated": false
}
},
"/operations/adtran-cloud-platform-uiworkflow:resolve-profiles": {
"post": {
"tags": [
"Resolving Profiles"
],
"summary": "Resolve Profiles for Device",
"description": "Returns a list of profiles that are associated with a specific device.\n\n \nRequest Payload Details\n\n\n| Attribute | Description |\n| --- | --- |\n| device-name | **Required:** A unique name for the device. |\n| include-overrides | Default Value: true. Setting to 'true' will ensure resolution of profiles that respects the profile overrides for the specified object. Setting to 'false' will ignore configured profile overrides and cause resolution to select profiles as if the overrides didn't exist. |\n\n \nResponse Details\n\n\n| Attribute | Description |\n| --- | --- |\n| name | Unique name of the profile. |\n| type | Type of the profile. |",
"operationId": "ResolveProfilesforDevice",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResolveProfilesforDeviceRequest"
},
"example": {
"input": {
"device-context": {
"device-name": "{{profiles-device-name}}"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Thu, 20 Aug 2020 23:23:24 GMT"
},
"example": "Thu, 20 Aug 2020 23:23:24 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Vary": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
},
"example": "Accept-Encoding"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "gzip"
},
"example": "gzip"
}
}
}
},
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/ResolveProfilesforDevice"
},
"example": {
"output": {
"profile": [
{
"type": "file-transfer-server-profile",
"name": "file-transfer-2"
}
]
}
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-profiles:profiles": {
"get": {
"tags": [
"Profiles"
],
"summary": "Get All Profiles",
"description": "Get Details of all Profiles in MCP. Returns the data for a requested profile as described below.\n\n**Response Details**\n\n|\tAttribute\t\t\t|\t\tDescription\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t |\n|-----------------------|------------------------------------------------------------------------------------------------|\n|\tname\t\t|Unique name of the profile.\t\t\t\t\t|\n| parameters\t\t| Collection of profile parameters in key-value pairs. name: Defines name of the parameter in a profile. value: Defines value of the profile parameter. hint: A textual short description of applicable values and its unit of measure. format: Defines format of the value in regular expressions. This may be used for validation of input data.|\n| state | State of the profile vector and profiles. Possible Values : configured, deployed, activated",
"operationId": "GetAllProfiles",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 01 Sep 2020 19:09:38 GMT"
},
"example": "Tue, 01 Sep 2020 19:09:38 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Vary": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
},
"example": "Accept-Encoding"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "W/\"efe6ee32-a7fe-4721-9fd4-9b594423c943\""
},
"example": "W/\"efe6ee32-a7fe-4721-9fd4-9b594423c943\""
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "private, no-cache"
},
"example": "private, no-cache"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "gzip"
},
"example": "gzip"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "235"
},
"example": "235"
}
}
}
},
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/GetAllProfiles"
},
"example": {
"profiles": {
"profile-type": [],
"profile": [
{
"name": "ANCP DSL Topology",
"state": "activated",
"type": "ancp-profile-type",
"parameters": {
"parameter": [
{
"name": "autoupgrade",
"value": "false"
},
{
"name": "filename",
"value": "cpe_firmware.bin"
},
{
"name": "reboot-timeout",
"value": "600"
},
{
"name": "version",
"value": "1.2.3.0"
}
]
}
},
{
"name": "ANCP DSL Topology Original",
"state": "activated",
"type": "ancp-profile-type",
"parameters": {
"parameter": [
{
"name": "autoupgrade",
"value": "false"
},
{
"name": "filename",
"value": "cpe_firmware.bin"
},
{
"name": "reboot-timeout",
"value": "600"
},
{
"name": "version",
"value": "1.2.3.0"
}
]
}
},
{
"name": "conditional",
"state": "activated",
"type": "conditional-profile-type",
"condition": {
"profile-name": "file-transfer-2",
"profile-type": "file-transfer-server-profile",
"device-condition": {
"default": true
}
}
},
{
"name": "ONU Ethernet UNI Profile",
"state": "activated",
"type": "ethernet-interface-type"
},
{
"name": "ONU Ethernet UNI Profile Original",
"state": "activated",
"type": "ethernet-interface-type"
},
{
"name": "another-profile",
"state": "activated",
"type": "ethernet-interface-type"
},
{
"name": "file-transfer-1",
"state": "activated",
"type": "file-transfer-server-profile"
},
{
"name": "file-transfer-2",
"state": "activated",
"type": "file-transfer-server-profile"
},
{
"name": "grouping",
"state": "activated",
"type": "grouping-profile-type",
"references": {
"reference": [
{
"profile-name": "another-profile",
"profile-type": "ethernet-interface-type"
},
{
"profile-name": "file-transfer-2",
"profile-type": "file-transfer-server-profile"
}
]
}
},
{
"name": "tpid-1",
"state": "activated",
"type": "tpid-profile-type"
}
],
"vectors": {
"vector": [
{
"name": "Device Config Vector",
"state": "activated",
"profile": [
{
"name": "ANCP DSL Topology Original",
"type": "ancp-profile-type"
}
],
"type": "device"
},
{
"name": "ONU Eth UNI Profile Vector",
"state": "activated",
"profile": [
{
"name": "ONU Ethernet UNI Profile Original",
"type": "ethernet-interface-type"
}
],
"type": "interface"
},
{
"profile": [],
"name": "SDX Service1 100M",
"state": "activated",
"type": "service"
},
{
"profile": [],
"name": "SDX Service1 100M DHCP",
"state": "activated",
"type": "service"
},
{
"profile": [],
"name": "Sample Bundle Vector",
"state": "activated",
"type": "bundle"
},
{
"name": "SimpleInterfaceVector",
"state": "activated",
"profile": [
{
"name": "file-transfer-2",
"type": "file-transfer-server-profile"
}
],
"type": "interface"
},
{
"name": "SimpleVector",
"state": "activated",
"profile": [
{
"name": "file-transfer-2",
"type": "file-transfer-server-profile"
}
],
"type": "device"
}
]
}
}
}
},
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/GetAllProfiles-Success"
},
"example": {
"profile": [
{
"name": "gold-profile",
"state": "configured"
},
{
"name": "profile-1",
"state": "activated",
"parameters": {
"parameter": [
{
"format": "^[a-z]$",
"name": "parameter-name",
"hint": "an excellent letter lower-cased from a-z",
"value": "g"
}
]
}
}
]
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-profiles:profiles/profile": {
"post": {
"tags": [
"Profiles"
],
"summary": "Add a Profile",
"description": "Creates a new profile and sends it straight to the `activated` state. This API replaces the deprecated `Create Profile`, `Configure Profile`, `Deploy Profile`, and `Activate Profile` APIs.\n\n \nRequest Payload Details\n\n\n| Attribute | Description |\n|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| name |**Required:** Unique name of the profile the user wishes to assign for personalization in their management system. |\n|type |**Required:** Type of the profile. |\n|state |**Required:** State of the profile - set to `activated` to be able to add the profile in one API call |\n|*other* |Profile data schema depends on type and will be specified in solution specific documentation. |",
"operationId": "AddaProfile",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddaProfileRequest"
},
"example": {
"name": "tpid-profile-1",
"state": "activated",
"type": "tpid-profile-type",
"tpid-profile": {
"stag-tpid": 8100,
"ctag-tpid": 8200
}
}
}
},
"required": true
},
"responses": {
"409": {
"description": "Conflict",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Mon, 31 Aug 2020 18:50:37 GMT"
},
"example": "Mon, 31 Aug 2020 18:50:37 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/AddaProfileConflict1"
},
"example": {
"message": "Cannot overwrite path List(adtran-cloud-platform-profiles, profiles, profile=tpid-profile-type,tpid-profile-1)"
}
}
}
},
"201": {
"description": "Created",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Mon, 31 Aug 2020 18:50:24 GMT"
},
"example": "Mon, 31 Aug 2020 18:50:24 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "\"33e05e91-0a81-418a-883d-28f2c8cceff5\""
},
"example": "\"33e05e91-0a81-418a-883d-28f2c8cceff5\""
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "no-store"
},
"example": "no-store"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-profiles:profiles/profile=tpid-profile-type,tpid-profile-1": {
"get": {
"tags": [
"Profiles"
],
"summary": "Get Profile",
"description": "Get details for a particular profile in Mosaic CP. Returns the contents of the profile. Each type of profile is YANG modeled and is documented in solution specific documentation.\n\n**Request URI Details**\n\n| Attribute | Description |\n|--------------|-----------------------------|\n| profile | Unique name of the profile. |\n| profile-type | Type of the profile |\n\n**Response Payload Details**\n\n| Attribute | Description |\n|-----------|-------------|\n| name | Unique name of the profile. |\n| type | Type of the profile. |\n| parameters | Collection of profile parameters in key-value pairs. name: Defines name of the parameter in a profile. value: Defines value of the profile parameter. hint: A textual short description of applicable values and its unit of measure. format: Defines format of the value in regular expressions. This may be used for validation of input data.|\n| state | State of the profiles. Possible Values : configured, deployed, activated |",
"operationId": "GetProfile",
"parameters": [],
"responses": {
"404": {
"description": "Not Found",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 01 Sep 2020 19:04:29 GMT"
},
"example": "Tue, 01 Sep 2020 19:04:29 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Vary": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
},
"example": "Accept-Encoding"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "gzip"
},
"example": "gzip"
}
}
}
},
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/GetProfileCantfindprofile1"
},
"example": {
"message": "Could not find path List(adtran-cloud-platform-profiles, profiles, profile=tpid-profile-type,tpid-profile-1)"
}
}
}
},
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 01 Sep 2020 19:03:33 GMT"
},
"example": "Tue, 01 Sep 2020 19:03:33 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Vary": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
},
"example": "Accept-Encoding"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "W/\"207ae31a-28a7-4355-bb4c-077c30285591\""
},
"example": "W/\"207ae31a-28a7-4355-bb4c-077c30285591\""
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "private, no-cache"
},
"example": "private, no-cache"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "gzip"
},
"example": "gzip"
}
}
}
},
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/GetProfile"
},
"example": {
"name": "tpid-profile-1",
"state": "activated",
"type": "tpid-profile-type",
"tpid-profile": {
"stag-tpid": 8100,
"ctag-tpid": 8200
}
}
}
}
}
},
"deprecated": false
},
"put": {
"tags": [
"Profiles"
],
"summary": "Update a Profile",
"description": "Updates an existing profile ignoring its current state. This API replaces the deprecated `Create Profile`, `Configure Profile`, `Deploy Profile`, and `Activate Profile` APIs.\n\n \nRequest Payload Details\n\n\n| Attribute | Description |\n|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| name |**Required:** Unique name of the profile the user wishes to assign for personalization in their management system. |\n|type |**Required:** Type of the profile. |\n|state |**Required:** State of the profile - set to `activated` to be able to add the profile in one API call |\n|*other* |Profile data schema depends on type and will be specified in solution specific documentation. YANG models delivered alongside Mosaic CP contain the formal schema. |",
"operationId": "UpdateaProfile",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateaProfileRequest"
},
"example": {
"name": "tpid-profile-1",
"state": "activated",
"type": "tpid-profile-type",
"tpid-profile": {
"stag-tpid": 8101,
"ctag-tpid": 8200
}
}
}
},
"required": true
},
"responses": {
"204": {
"description": "No Content",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Mon, 31 Aug 2020 21:36:18 GMT"
},
"example": "Mon, 31 Aug 2020 21:36:18 GMT"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "\"632b906d-3736-4405-8b96-239328ba087b\""
},
"example": "\"632b906d-3736-4405-8b96-239328ba087b\""
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "no-store"
},
"example": "no-store"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {}
}
},
"deprecated": false
},
"delete": {
"tags": [
"Profiles"
],
"summary": "Remove a Profile",
"description": "Deletes an existing profile, disregarding the current state of the profile. If the profile is currently in use by a profile vector, this request is expected to fail with a `400 Bad Request` error. In this case, remove the profile from the vector before deleting it.\n
\n**Request URI Details**\n\n| Attribute | Description |\n|--------------|-----------------------------|\n| profile | Unique name of the profile. |\n| profile-type | Type of the profile |",
"operationId": "RemoveaProfile",
"parameters": [],
"responses": {
"204": {
"description": "No Content",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Mon, 31 Aug 2020 19:26:49 GMT"
},
"example": "Mon, 31 Aug 2020 19:26:49 GMT"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "\"cb879c90-37e2-47aa-8077-09f394782a31\""
},
"example": "\"cb879c90-37e2-47aa-8077-09f394782a31\""
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "no-store"
},
"example": "no-store"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {}
},
"404": {
"description": "Not Found",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Mon, 31 Aug 2020 19:27:06 GMT"
},
"example": "Mon, 31 Aug 2020 19:27:06 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Vary": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
},
"example": "Accept-Encoding"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "gzip"
},
"example": "gzip"
}
}
}
},
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/RemoveaProfiledoesntexist1"
},
"example": {
"message": "Could not find path List(adtran-cloud-platform-profiles, profiles, profile=tpid-profile-type,tpid-profile-1)"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Mon, 31 Aug 2020 22:19:28 GMT"
},
"example": "Mon, 31 Aug 2020 22:19:28 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/RemoveaProfileConnectedtoanexistingprofilevector1"
},
"example": {
"message": "Cannot remove path 'adtran-cloud-platform-profiles:profiles/profile=tpid-profile-type,tpid-profile-1' due to reference from 'adtran-cloud-platform-profiles:profiles/vectors/vector=chris-test/profile=tpid-profile-type,tpid-profile-1'}"
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-overrides:overrides": {
"get": {
"tags": [
"Profiles"
],
"summary": "Get Overridden Profiles List for All MCP Objects",
"description": "A list of objects with a list of overridden profiles for that object.\n\n**Response Details**\n\n| Attributes | Description |\n|---|---|\n|device-override|A list of devices with a list of its overridden profiles.|\n|interface-override|A list of interfaces with a list of its overridden profiles.|\n|name|A name that uniquely identifies the profile name.|\n|type|A name that uniquely identifies the profile type.|",
"operationId": "GetOverriddenProfilesListforAllMCPObjects",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Sat, 09 May 2020 02:06:21 GMT"
},
"example": "Sat, 09 May 2020 02:06:21 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "425"
},
"example": "425"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "private, no-cache"
},
"example": "private, no-cache"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "\"50c4712b-2cdf-4182-8ba6-3c10b2c14593\""
},
"example": "\"50c4712b-2cdf-4182-8ba6-3c10b2c14593\""
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/GetOverriddenProfilesListforAllMCPObjects"
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-profiles:profiles/vectors": {
"get": {
"tags": [
"Profile Vectors"
],
"summary": "Get All Profile Vectors",
"description": "Get Details of all Profile Vectors in MCP. Returns the data for a requested profile vector as described below.\n\n**Response Details**\n\n| Attribute | Description |\n|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| name |Unique name of the profile vector.|\n| profile |Contains profiles and their types. name: Name that uniquely identifies the profile. type: Type of the profile. Possible Values : generic| |\n| state | State of the profile vector. Possible Values : configured, deployed, activated |\n|type | Profile vector type. Possible Values: device, interface, service, content-provider, bundle. |",
"operationId": "GetAllProfileVectors",
"parameters": [],
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-profiles:profiles/vectors/vector=NewProfileVector": {
"post": {
"tags": [
"Profile Vectors"
],
"summary": "Add a Profile Vector",
"description": "Creates a new profile vector in the `activated` state using the profiles listed.\n\n\n \nRequest Payload Details\n\n\n| Attribute | Description |\n|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| name |Unique name of the profile vector.|\n| profile |Contains profiles and their types. name: Name that uniquely identifies the profile. type: Type of the profile. Possible Values : generic| |\n| state | State of the profile vector. Possible Values: configured, deployed, activated |\n|type | Profile vector type. Possible Values : device, interface, service, content-provider, bundle. |",
"operationId": "AddaProfileVector",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddaProfileVectorRequest"
},
"example": {
"name": "NewProfileVector",
"profile": [
{
"name": "{{pv-profile-name-1}}",
"type": "tpid-profile-type"
},
{
"name": "{{pv-profile-name-2}}",
"type": "vectoring-profile-type"
}
],
"state": "activated",
"type": "device"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 11 Sep 2020 19:54:30 GMT"
},
"example": "Fri, 11 Sep 2020 19:54:30 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "\"b5a98367-8725-4ed2-8a8e-028741019be7\""
},
"example": "\"b5a98367-8725-4ed2-8a8e-028741019be7\""
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "no-store"
},
"example": "no-store"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {}
}
},
"deprecated": false
},
"get": {
"tags": [
"Profile Vectors"
],
"summary": "Get Profile Vector",
"description": "Get a specific profile vector as described below.\n\n**Response Details**\n\n| Attribute | Description |\n|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| name |Unique name of the profile vector.|\n| profile |Contains profiles and their types. name: Name that uniquely identifies the profile. type: Type of the profile. Possible Values: generic| |\n| state | State of the profile vector. Possible Values: configured, deployed, activated |\n|type | Profile vector type. Possible Values : device, interface, service, content-provider, bundle. |",
"operationId": "GetProfileVector",
"parameters": [],
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"deprecated": false
},
"put": {
"tags": [
"Profile Vectors"
],
"summary": "Update a Profile Vector",
"description": "Updates an existing profile vector.\n\n\n \nRequest Payload Details\n\n\n| Attribute | Description |\n|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| name |Unique name of the profile vector.|\n| profile |Contains profiles and their types. name: Name that uniquely identifies the profile. type: Type of the profile. Possible Values: generic| |\n| state | State of the profile vector. Possible Values: configured, deployed, activated |\n|type | Profile vector type. Possible Values: device, interface, service, content-provider, bundle. |",
"operationId": "UpdateaProfileVector",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateaProfileVectorRequest"
},
"example": {
"name": "NewProfileVector",
"profile": [
{
"name": "{{pv-profile-name-1}}",
"type": "tpid-profile-type"
}
],
"state": "activated",
"type": "device"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "No Content",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 11 Sep 2020 19:55:04 GMT"
},
"example": "Fri, 11 Sep 2020 19:55:04 GMT"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "\"56584f7e-734b-4686-aad6-261430453b1a\""
},
"example": "\"56584f7e-734b-4686-aad6-261430453b1a\""
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "no-store"
},
"example": "no-store"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {}
}
},
"deprecated": false
},
"delete": {
"tags": [
"Profile Vectors"
],
"summary": "Remove a Profile Vector",
"description": "Deletes an existing profile vector, regardless of current state.",
"operationId": "RemoveaProfileVector",
"parameters": [],
"responses": {
"204": {
"description": "No Content",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 11 Sep 2020 19:56:05 GMT"
},
"example": "Fri, 11 Sep 2020 19:56:05 GMT"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "\"db3f314e-c72f-4e16-874d-309651d97bca\""
},
"example": "\"db3f314e-c72f-4e16-874d-309651d97bca\""
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "no-store"
},
"example": "no-store"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {}
},
"400": {
"description": "Bad Request",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 11 Sep 2020 20:01:04 GMT"
},
"example": "Fri, 11 Sep 2020 20:01:04 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/RemoveaProfileVectorinUsebyAnotherObject1"
},
"example": {
"message": "Cannot remove path 'adtran-cloud-platform-profiles:profiles/vectors/vector=NewProfileVector' due to reference from 'adtran-cloud-platform-devices:devices/device=device-to-resolve'}"
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-profiles:profiles/profile=conditional-profile-type,ExampleDeviceConditional": {
"delete": {
"tags": [
"Conditional Profiles (Behaviors)"
],
"summary": "Delete Conditional Profile (Device Condition)",
"description": "Removes the conditional profile.\n\n|URI Attributes|Description|\n|----------|-----------|\n|type|`conditional-profile-type`|\n|name|Name of the conditional profile.|",
"operationId": "DeleteConditionalProfile(DeviceCondition)",
"parameters": [],
"responses": {
"204": {
"description": "No Content",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Wed, 16 Dec 2020 20:28:48 GMT"
},
"example": "Wed, 16 Dec 2020 20:28:48 GMT"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "\"a9823ff2-386e-42f1-84e0-efe1436dab89\""
},
"example": "\"a9823ff2-386e-42f1-84e0-efe1436dab89\""
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "no-store"
},
"example": "no-store"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
}
},
"content": {}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-profiles:profiles/profile=conditional-profile-type,ExampleInterfaceConditional": {
"delete": {
"tags": [
"Conditional Profiles (Behaviors)"
],
"summary": "Delete Conditional Profile (Interface Condition)",
"description": "Removes the conditional profile.\n\n|URI Attributes|Description|\n|----------|-----------|\n|type|`conditional-profile-type`|\n|name|Name of the conditional profile.|",
"operationId": "DeleteConditionalProfile(InterfaceCondition)",
"parameters": [],
"responses": {
"204": {
"description": "No Content",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Wed, 16 Dec 2020 20:29:18 GMT"
},
"example": "Wed, 16 Dec 2020 20:29:18 GMT"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "\"315bfa31-c590-4fa2-8e62-043c1ebe4f77\""
},
"example": "\"315bfa31-c590-4fa2-8e62-043c1ebe4f77\""
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "no-store"
},
"example": "no-store"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
}
},
"content": {}
}
},
"deprecated": false
}
},
"/operations/adtran-cloud-platform-uiworkflow:select-behavior": {
"post": {
"tags": [
"Interface Name (Highest Priority)"
],
"summary": "Select By Interface Name",
"description": "Add interfaces by their name to a behavior. If using only a single interface name here instead of a list, consider using profile overrides instead which are better targeted to one-off type of changes and are supported in the Mosaic CP GUI as well as via API.\n\n|Attributes|Description|\n|----------|-----------|\n|behavior-group|Name of a behavior group (name matches a grouping profile which has `selectable` set to true).|\n|behavior|Name of a behavior in selected behavior group (name matches a conditional profile which is included in the above named `behavior-group` grouping profile). |\n|interface-name|Specified set of user interface names that, when any are matched, determines reference behavior to select.|",
"operationId": "SelectByInterfaceName",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelectByInterfaceNameRequest"
},
"example": {
"input": {
"behavior-context": {
"behavior-group": "{{select-behavior-tpid}}",
"behavior": "{{select-behavior-cp-site-a}}",
"interface-context": {
"interface-name": [
"{{select-behavior-sim-int-name}}"
]
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 15 Dec 2020 17:10:56 GMT"
},
"example": "Tue, 15 Dec 2020 17:10:56 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Vary": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
},
"example": "Accept-Encoding"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "gzip"
},
"example": "gzip"
}
}
}
},
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/SelectByInterfaceName"
},
"example": {
"output": {
"timestamp": "2020-12-15T17:10:56.022834",
"status": "select-behavior",
"trans-id": "683c3293-6f25-4184-8eb9-b8d936c560eb",
"completion-status": "in-progress",
"select-behavior": "sb-tpid-behavior"
}
}
}
}
}
},
"deprecated": false
}
},
"/operations/adtran-cloud-platform-uiworkflow:deselect-behavior": {
"post": {
"tags": [
"Interface Name (Highest Priority)"
],
"summary": "Deselect Interface Name",
"description": "Remove a named interface behavior.\n\n|Attributes|Description|\n|----------|-----------|\n|behavior-group|Name of a behavior group.|\n|behavior|Name of a behavior in selected behavior group.|\n|interface-name|Specified set of user interface names that, when any are matched, determines reference behavior to deselect.|",
"operationId": "DeselectInterfaceName",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeselectInterfaceNameRequest"
},
"example": {
"input": {
"behavior-context": {
"behavior-group": "{{select-behavior-tpid}}",
"behavior": "{{select-behavior-cp-site-a}}",
"interface-context": {
"interface-name": [
"{{select-behavior-sim-int-name}}"
]
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 15 Dec 2020 17:11:26 GMT"
},
"example": "Tue, 15 Dec 2020 17:11:26 GMT"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Vary": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
},
"example": "Accept-Encoding"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "gzip"
},
"example": "gzip"
}
}
}
},
"content": {
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/DeselectIncludeInterfaceBehavior"
},
"example": {
"output": {
"deselect-behavior": "sb-tpid-behavior",
"timestamp": "2020-12-15T17:11:25.999794",
"status": "deselect-behavior",
"trans-id": "c5a561e2-0b77-4028-b4e5-fe2065ae9e58",
"completion-status": "in-progress"
}
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-profiles:profiles/profile=grouping-profile-type,example-behavior-group": {
"delete": {
"tags": [
"Behavioral Intent"
],
"summary": "Delete Grouping Profile (Behavior Group)",
"description": "Removes a selectable behavior group.\n\n|URI Attributes|Description|\n|----------|-----------|\n|type|`grouping-profile-type` for a behavior group.|\n|name|Name of the behavior group.|",
"operationId": "DeleteGroupingProfile(BehaviorGroup)",
"parameters": [],
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-uiworkflow-behaviors:behaviors": {
"get": {
"tags": [
"Behavioral Intent"
],
"summary": "Get All Behavior Groups",
"description": "Fetches all the Behavior Groups and respective behaviors.\n\n \nResponse Details\n\n\n|Attributes|Description|\n|----------|-----------|\n|name| Name of behavior group.|\n|behavior|List of associated behaviors of the behavior group.|",
"operationId": "GetAllBehaviorGroups",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Tue, 12 May 2020 18:50:51 GMT"
},
"example": "Tue, 12 May 2020 18:50:51 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "4532"
},
"example": "4532"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
},
"Transfer-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "chunked"
},
"example": "chunked"
}
}
},
"Vary": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Accept-Encoding"
},
"example": "Accept-Encoding"
}
}
},
"Strict-Transport-Security": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "max-age=63072000"
},
"example": "max-age=63072000"
}
}
},
"Content-Encoding": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "gzip"
},
"example": "gzip"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/GetAllBehaviors"
},
"example": {
"behaviors": {
"behavior-group": [
{
"name": "LCI Group",
"behavior": [
{
"name": "OLT LCI Condition"
}
]
},
{
"name": "LCI OLT Group",
"behavior": []
},
{
"name": "OLT Upgrade Profile Group",
"behavior": [
{
"name": "SDX 6010 OLT Upgrade Conditional Profile"
},
{
"name": "SDX 6310 OLT Upgrade Conditional Profile"
},
{
"name": "SDX 6312 OLT Upgrade Conditional Profile"
},
{
"name": "SDX 6320 OLT Upgrade Conditional Profile"
}
]
},
{
"name": "ONU Upgrade Group",
"behavior": [
{
"name": "401 GPON ONU Upgrade Conditional Profile"
},
{
"name": "411 GPON ONU Upgrade Conditional Profile"
},
{
"name": "SDX 602V Upgrade Conditional Profile"
},
{
"name": "SDX 602X Upgrade Conditional Profile"
},
{
"name": "SDX 611 GPON ONU Upgrade Conditional Profile"
},
{
"name": "SDX 621V Upgrade Conditional Profile"
},
{
"name": "SDX 621X Upgrade Conditional Profile"
}
]
},
{
"name": "Residential Data Service Group",
"behavior": [
{
"name": "OLT Residential Data Service Condition"
},
{
"name": "ONU Residential Data Service Condition"
}
]
},
{
"name": "Residential Data Service OLT Group",
"behavior": []
},
{
"name": "Residential Data Service ONU Group",
"behavior": []
},
{
"name": "Residential Video Service Group",
"behavior": [
{
"name": "OLT Residential Video Service Condition"
},
{
"name": "ONU Residential Video Service Condition"
}
]
},
{
"name": "Residential Video Service OLT Group",
"behavior": []
},
{
"name": "Residential Video Service ONU Group",
"behavior": []
},
{
"name": "SDX Service1 Group",
"behavior": [
{
"name": "OLT Service1 Condition"
},
{
"name": "ONU Service1 Condition"
}
]
},
{
"name": "SDX Service1 Group DHCP",
"behavior": [
{
"name": "OLT Service1 Condition DHCP"
},
{
"name": "ONU Service1 Condition"
}
]
},
{
"name": "SDX Service1 Group PPPoE",
"behavior": [
{
"name": "OLT Service1 Condition PPPoE"
},
{
"name": "ONU Service1 Condition"
}
]
},
{
"name": "SDX Service1 OLT Group",
"behavior": []
},
{
"name": "SDX Service1 OLT Group DHCP",
"behavior": []
},
{
"name": "SDX Service1 OLT Group PPPoE",
"behavior": []
},
{
"name": "SDX Service1 ONU Group",
"behavior": []
},
{
"name": "SDX Service2 Group",
"behavior": [
{
"name": "OLT Service2 Condition"
},
{
"name": "ONU Service2 Condition"
}
]
},
{
"name": "SDX Service2 Group ANCP",
"behavior": [
{
"name": "OLT Service2 Condition ANCP"
},
{
"name": "ONU Service2 Condition"
}
]
},
{
"name": "SDX Service2 Group DHCP",
"behavior": [
{
"name": "OLT Service2 Condition DHCP"
},
{
"name": "ONU Service2 Condition"
}
]
},
{
"name": "SDX Service2 Group DHCP and ANCP",
"behavior": [
{
"name": "OLT Service2 Condition DHCP and ANCP"
},
{
"name": "ONU Service2 Condition"
}
]
},
{
"name": "SDX Service2 Group PPPoE",
"behavior": [
{
"name": "OLT Service2 Condition PPPoE"
},
{
"name": "ONU Service2 Condition"
}
]
},
{
"name": "SDX Service2 Group PPPoE and ANCP",
"behavior": [
{
"name": "OLT Service2 Condition PPPoE and ANCP"
},
{
"name": "ONU Service2 Condition"
}
]
},
{
"name": "SDX Service2 Group Scheduler",
"behavior": [
{
"name": "OLT Service2 Condition Scheduler"
},
{
"name": "ONU Service2 Condition"
}
]
},
{
"name": "SDX Service2 OLT Group",
"behavior": []
},
{
"name": "SDX Service2 OLT Group ANCP",
"behavior": []
},
{
"name": "SDX Service2 OLT Group DHCP",
"behavior": []
},
{
"name": "SDX Service2 OLT Group DHCP and ANCP",
"behavior": []
},
{
"name": "SDX Service2 OLT Group PPPoE",
"behavior": []
},
{
"name": "SDX Service2 OLT Group PPPoE and ANCP",
"behavior": []
},
{
"name": "SDX Service2 OLT Group Scheduler",
"behavior": []
},
{
"name": "SDX Service2 ONU Group",
"behavior": []
},
{
"name": "SDX Service3 Group",
"behavior": [
{
"name": "OLT Service3 Condition"
},
{
"name": "ONU Service3 Condition"
}
]
},
{
"name": "SDX Service3 Group DHCP",
"behavior": [
{
"name": "OLT Service3 Condition DHCP"
},
{
"name": "ONU Service3 Condition"
}
]
},
{
"name": "SDX Service3 Group PPPoE",
"behavior": [
{
"name": "OLT Service3 Condition PPPoE"
},
{
"name": "ONU Service3 Condition"
}
]
},
{
"name": "SDX Service3 Group Scheduler",
"behavior": [
{
"name": "OLT Service3 Condition Scheduler"
},
{
"name": "ONU Service3 Condition"
}
]
},
{
"name": "SDX Service3 OLT Group",
"behavior": []
},
{
"name": "SDX Service3 OLT Group DHCP",
"behavior": []
},
{
"name": "SDX Service3 OLT Group PPPoE",
"behavior": []
},
{
"name": "SDX Service3 OLT Group Scheduler",
"behavior": []
},
{
"name": "SDX Service3 ONU Group",
"behavior": []
},
{
"name": "SDX Service4 Group",
"behavior": [
{
"name": "OLT Service4 Condition"
},
{
"name": "ONU Service4 Condition"
}
]
},
{
"name": "SDX Service4 Group DHCP",
"behavior": [
{
"name": "OLT Service4 Condition DHCP"
},
{
"name": "ONU Service4 Condition"
}
]
},
{
"name": "SDX Service4 Group PPPoE",
"behavior": [
{
"name": "OLT Service4 Condition PPPoE"
},
{
"name": "ONU Service4 Condition"
}
]
},
{
"name": "SDX Service4 OLT Group",
"behavior": []
},
{
"name": "SDX Service4 OLT Group DHCP",
"behavior": []
},
{
"name": "SDX Service4 OLT Group PPPoE",
"behavior": []
},
{
"name": "SDX Service4 ONU Group",
"behavior": []
}
]
}
}
},
"application/json;charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/GetAllBehaviors1"
},
"example": {
"behaviors": {
"behavior-group": [
{
"name": "sb-tpid-behavior",
"behavior": [
{
"name": "sb-dev-cp-site-a"
},
{
"name": "sb-dev-cp-site-b"
}
]
}
]
}
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-labels:labels/label": {
"post": {
"tags": [
"Labels"
],
"summary": "Add Label",
"description": "Creates and add a new label or add an existing label to the referenced object(s). Multiple labels can be added to same referenced object(s).\n\n \nRequest Payload Details -\n\n| Attribute | Description |\n| --- | --- |\n| name | **Required**: The name of the label. |\n| referenced-objects | **Required**: A list of objects referenced by the label. **name**: The name of the object being referenced. **object-type**: The type of object being referenced. e.g. `device` or `interface` |",
"operationId": "AddLabel",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddLabelRequest"
},
"example": {
"name": "label_1",
"referenced-objects": [
{
"name": "device_test1",
"object-type": "device"
}
]
}
}
},
"required": true
},
"responses": {
"400": {
"description": "Bad Request",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 08 May 2020 11:17:44 GMT"
},
"example": "Fri, 08 May 2020 11:17:44 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "252"
},
"example": "252"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/AddLabel-DeviceNotExists1"
},
"example": {
"message": "Cannot insert path 'adtran-cloud-platform-labels:labels/label=label_4/referenced-objects=device,unknown device' due non-existing reference to 'adtran-cloud-platform-devices:devices/device=unknown device'"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 08 May 2020 11:15:50 GMT"
},
"example": "Fri, 08 May 2020 11:15:50 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "98"
},
"example": "98"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/AddLabel-LabelAlreadyExists1"
},
"example": {
"message": "Cannot overwrite path List(adtran-cloud-platform-labels, labels, label=label_1)"
}
}
}
},
"201": {
"description": "Created",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 08 May 2020 11:13:01 GMT"
},
"example": "Fri, 08 May 2020 11:13:01 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "0"
},
"example": "0"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "no-store"
},
"example": "no-store"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "\"665f6071-f7d9-4dd5-aecf-c1e7e882941f\""
},
"example": "\"665f6071-f7d9-4dd5-aecf-c1e7e882941f\""
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {}
}
},
"deprecated": false
}
},
"/data-filter/adtran-cloud-platform-labels:labels/label": {
"post": {
"tags": [
"Labels"
],
"summary": "Data Filter For Label",
"description": "Search for labels based on objects. Provides the result against given `referenced-objects` values passed.\n\n \nRequest Payload Details -\n\n| Attribute |Description |\n| --- | --- |\n| referenced-objects | **Required:** A list of objects referenced by the label. **name**: The name of the object being referenced. **object-type**: The type of object being referenced. e.g. `device` or `interface` |\n\n \nResponse Data -\n\n| Attribute | Description |\n| --- | --- |\n| label | A list of objects containing each label. Contains lists of labels and referenced-objects:|\n| name | The name of the label. |\n| referenced-objects | A list of objects referenced by the label. **name**: The name of the object being referenced. **object-type**: The type of object being referenced. e.g. `device` or `interface` |",
"operationId": "DataFilterForLabel",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataFilterForLabelRequest"
},
"example": {
"referenced-objects": {
"name": "device_test1",
"object-type": "device"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 08 May 2020 12:23:51 GMT"
},
"example": "Fri, 08 May 2020 12:23:51 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "12"
},
"example": "12"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "no-store"
},
"example": "no-store"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "\"2e874c7e-d570-4ffb-a7d5-79cae055a0e6\""
},
"example": "\"2e874c7e-d570-4ffb-a7d5-79cae055a0e6\""
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/DataFilterForLabel-IncorrectDeviceName"
},
"example": {
"label": []
}
}
}
}
},
"deprecated": false
}
},
"/operations/adtran-cloud-platform-search:search": {
"post": {
"tags": [
"Labels"
],
"summary": "Search Label",
"description": "Search a list of labels or search a specific label associated to the objects.\n\n \nRequest Payload Details -\n\n| Attribute | Description |\n| --- | --- |\n| type | **Required:** Specify the type of search to be performed. e.g. `search-global` |\n| cursor | **Required:** Returns cursor with the next value in order to complete a paginated response. Default value: 0 |\n| search-term | **Required:** String or substring of name of the label to be searched for. |\n| object-type | **Required:** Type of object to be retrieved. e.g. `label` |\n| search-field | Filter all data based on the search field. e.g. `name` |\n| result-size | Size of records to be returned in a single query. Possible values: 0..1000 Default value: 25 |\n\n\n \nResponse Data Details -\n\n| Attribute | Description |\n| --- | --- |\n| count | Count of matching objects returned. |\n| cursor | Returns cursor with the next value in order to complete a paginated response. |\n| matching-object | A list of objects found which match the supplied term. |\n| name | The name of the label that was found. |\n| label/referenced-objects | The entry or entires found for the label. **name**: The name of the object. **object-type**: The type of the object. e.g. `device` or `interface` |\n| type | Represents the type of search that was performed. |",
"operationId": "SearchLabel",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchLabelRequest"
},
"example": {
"input": {
"type": "search-global",
"related-objects-term": {
"cursor": 0,
"result-size": 25,
"search-term": "label_1",
"object-type": "label",
"search-field": "name"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 08 May 2020 11:34:20 GMT"
},
"example": "Fri, 08 May 2020 11:34:20 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "338"
},
"example": "338"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/SearchLabels-SearchAllLabels"
},
"example": {
"output": {
"related-object-results": {
"count": 2,
"cursor": 2,
"matching-object": [
{
"name": "label_1",
"label": {
"referenced-objects": [
{
"object-type": "device",
"name": "device_test1"
},
{
"object-type": "interface",
"name": "interface_1"
}
],
"name": "label_1"
}
},
{
"name": "label_2",
"label": {
"referenced-objects": [],
"name": "label_2"
}
}
]
},
"type": "search-global"
}
}
}
}
}
},
"deprecated": false
}
},
"/data/adtran-cloud-platform-labels:labels/label=label_1": {
"delete": {
"tags": [
"Labels"
],
"summary": "Delete Label",
"description": "Deletes the label with respect to passed query parameters in request URL. Request type is `DELETE` in this case.\n\n \nRequest Url Query Data Details -\n\n| Attribute | Description |\n| --- | --- |\n| label | **Required** Name of the label to be deleted. |\n| referenced-objects | Comma-separated type and name of the referenced object from where the label is to be deleted. e.g. `interface,interface_1` |",
"operationId": "DeleteLabel",
"parameters": [],
"responses": {
"404": {
"description": "Not Found",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 08 May 2020 11:30:49 GMT"
},
"example": "Fri, 08 May 2020 11:30:49 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "149"
},
"example": "149"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {
"application/json; charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/DeleteLabel-InterfaceNotExists1"
},
"example": {
"message": "Could not find path List(adtran-cloud-platform-labels, labels, label=label_1, referenced-objects=interface,unknown_interface)"
}
}
}
},
"204": {
"description": "No Content",
"headers": {
"Date": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "Fri, 08 May 2020 11:26:43 GMT"
},
"example": "Fri, 08 May 2020 11:26:43 GMT"
}
}
},
"Content-Length": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "0"
},
"example": "0"
}
}
},
"Connection": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "keep-alive"
},
"example": "keep-alive"
}
}
},
"Cache-Control": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "no-store"
},
"example": "no-store"
}
}
},
"ETag": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "\"4fe453a0-a514-45ea-8680-2159fe25ef5a\""
},
"example": "\"4fe453a0-a514-45ea-8680-2159fe25ef5a\""
}
}
},
"Access-Control-Allow-Origin": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "*"
},
"example": "*"
}
}
},
"X-Frame-Options": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "sameorigin"
},
"example": "sameorigin"
}
}
}
},
"content": {}
}
},
"deprecated": false
}
},
"/operations/adtran-cloud-platform-uiworkflow:onboard-device": {
"post": {
"tags": [
"Create Device Using Port Pattern"
],
"summary": "Onboard Device Using Port Pattern",
"description": "RPC to perform configure and deploy steps of a device by using the new port pattern and its associated interfaces and an optional bundle.\n\n \nRequest Payload Details\n\n\n| Attribute | Description |\n|---|---|\n| rollback-on-failure | Optional: If true, and when device-onboard fails at a certain object, deletes all of its previously created objects. Default value : true |\n| device-context | Context information to configure and deploy device. |\n| management-domain-context | The management domain of the device |\n| interface-context\t| Context information to configure and deploy interface. |\n| bundle-context | Optional: Context information to configure and deploy the bundle. |\n| device-name | **Required:** A unique name for the device. |\n| model-name | **Required:** Part name of the device. |\n|interface-name-pattern| **Required:** Unique naming pattern of the interface.The user wishes to assign for personalization in their management system. This leaf holds interface pattern that supports below variables. \n|bundle-id-pattern| This leaf holds bundle ID pattern that supports below variables.
counter
port
These variables, when used, start and end with $. The $port$ can also contain a pattern to enforce length of port number such as $port%2$ will enforce a port number to be two digit by prepending 0 to port if port is single digit. Example if port is 1 $port%2$ will make it 01. Static strings can be part of the pattern if used along with variables. Example Patterns:
$counter$/$port%2$
4321/$port%2$
bundle-1
Some solutions require the bundle IDs to follow a specific format. In such cases, the bundle-id-pattern should be specified accordingly. The only special characters supported in patterns are hyphen (-) and slash (/).|\n| base-configuration | Base configuration associated with the device |\n| part-number | The part number (either ADTRAN or other vendor) of the device. |\n| credentials-name | Name of the credentials resource |\n| profile-vector-name | Name of the device type profile vector to associate with this device. |\n| interface-id-pattern | This leaf holds interface ID pattern that supports below variables.
interface-type
slot(always zero when mentioned in pattern)
port
These variables, when used, start and end with $. The port can additionally contain a pattern to enforce length of port by specifying %n where n stands for port length where n is a a number greater than 0. Static strings can be part of the pattern if used along with variables.Example Patterns:
gfast $slot$/$por%2$
gigabit-ethernet $slot$/$port%2$
eth $port%2$;
Wrong Patterns:
gfast
gfast $slot
The only special characters supported in patterns are hyphen (-), slash (/) and space. |\n| lower-layer-interfaces | List of the lower layer interfaces. e.g. in an EFM group|\n|shelf-range|Select shelf range between from and to. **from** Start shelf of the range. **to** End shelf of the range. |\n|slot-range|Select slot range between from and to. **from** Start slot of the range. **to** End slot of the range.|\n|port-range|Select port range between from and to. **from** Start port of the range. **to** End port of the range.|\n|bundle-name-pattern|This leaf holds bundle name pattern that supports below variables.
device-name
slot
port
These variables, when used, start and end with $. Static strings can be part of the pattern if used along with variables. The port can also hold a pattern such as $port%2$ which enforces the port to become double digit by appending leading 0 if port is single digit.Example Patterns: