Mosaic CP API Guide

Introduction

This 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.

The 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.

The figure below illustrates the interactions between the OSS and Mosaic CP. The network elements will vary according to the deployment.

The main sections that make up this guide are as follows:

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.
Events: covers APIs to retrieve events from the system and forward events to external systems such as a Kafka listener.
Jobs: using Mosaic CP to create, run, and check the status of jobs.
Platform Details: get the status of Mosaic CP as well as information about software versions and enabled features.
Orchestration Objects: this section covers using Mosaic CP as an SDN orchestrator.
Search and Filter: how to search for objects on the system and filter those searches based on various attributes of those objects.

← Select an endpoint from the sidebar to view its details.

Field	Required	Description
username	Yes	The unique username of the user.
password	Yes	The password of the user account for which the token is to be created.

access-control-allow-origin	*
connection	keep-alive
content-type	application/json; charset=UTF-8
date	Tue, 05 May 2020 09:17:31 GMT
x-frame-options	sameorigin

Date	Tue, 05 May 2020 10:52:44 GMT
Content-Type	application/json; charset=UTF-8
Connection	keep-alive
Access-Control-Allow-Origin	*
X-Frame-Options	sameorigin

access-control-allow-origin	*
connection	keep-alive
content-type	application/json; charset=UTF-8
date	Tue, 05 May 2020 10:05:24 GMT
x-frame-options	sameorigin

Field	Required	Description
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_
password-expiry-days		Number of days after which user's password will expire. Possible values: -1 _Indicates that password never expires_ 1..180 _Indicate the number of days for which the password would be valid_ Default value : _90 days _
password-min-len		Minimum length of password. Possible values:_ 6..128_ Default value: _ 8 _
password-max-len		Maximum length of password. Possible values: _ 6..128_ Default value: _ 128 _
password-uppercase-min-len		Minimum number of upper case characters required in password. Possible values : _ 0..128_ Default value : _ 1 _
password-min-digits		Minimum number of digits required in password. Possible values: _ 0..128_ Default value :_ 1 _
password-min-special-char		Minimum number of special characters required in password. Possible values : _ 0..128_ Default value: _ 1 _
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!@#$%^&*] _
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 _
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 _
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_
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_
account-lock-period		Amount of time (in minutes) for which user's account gets locked. Possible values : _ 1...65535 minutes_ Default value: _ 5 minutes_
authentication-mode		The mode for user authentication in priority order. Possible values : _ internal, radius, tacacsplus_ Default value: _internal_
authorization-mode		The mode for user authorization in priority order. Possible values : _ internal, radius, tacacsplus_ Default value: _internal_
accounting-mode		The mode for user accounting in priority order. Possible values : _ internal, radius, tacacsplus_ Default value: _internal_

Date	Fri, 08 May 2020 10:36:24 GMT
Content-Type	application/json; charset=UTF-8
Connection	keep-alive
Access-Control-Allow-Origin	*
X-Frame-Options	sameorigin

Date	Fri, 08 May 2020 10:34:49 GMT
Content-Type	application/json; charset=UTF-8
Connection	keep-alive
Access-Control-Allow-Origin	*
X-Frame-Options	sameorigin

Field	Required	Description
name	Yes	A unique name of this group.
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.
domains		A list of domains this group may access. Deprecated, set to empty list.

Date	Mon, 11 May 2020 10:01:10 GMT
Connection	keep-alive
Access-Control-Allow-Origin	*
X-Frame-Options	sameorigin

Date	Mon, 11 May 2020 11:36:52 GMT
Connection	keep-alive
Access-Control-Allow-Origin	*
X-Frame-Options	sameorigin

Date	Tue, 05 Jan 2021 16:26:20 GMT
Content-Type	application/json;charset=utf-8
Connection	keep-alive
Vary	Accept-Encoding
Access-Control-Allow-Origin	*
X-Frame-Options	sameorigin
Strict-Transport-Security	max-age=63072000
Content-Encoding	gzip

Date	Tue, 05 Jan 2021 16:28:21 GMT
Content-Type	application/json;charset=utf-8
Connection	keep-alive
Vary	Accept-Encoding
Access-Control-Allow-Origin	*
X-Frame-Options	sameorigin
Strict-Transport-Security	max-age=63072000
Content-Encoding	gzip

Field	Required	Description
name		Name of the module.
permissions		List of all APIs associated with the module.

Field	Required	Description
username	Yes	A unique username of the user.
password	Yes	Password which will authenticate the user.
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 _

Date	Tue, 05 May 2020 11:31:13 GMT
Connection	keep-alive
Access-Control-Allow-Origin	*
X-Frame-Options	sameorigin

Date	Fri, 08 May 2020 10:49:17 GMT
Content-Type	application/json; charset=UTF-8
Connection	keep-alive
Access-Control-Allow-Origin	*
X-Frame-Options	sameorigin

Date	Fri, 08 May 2020 10:50:54 GMT
Content-Type	application/json; charset=UTF-8
Connection	keep-alive
Access-Control-Allow-Origin	*
X-Frame-Options	sameorigin

Field	Required	Description
username	Yes	Username for which password reset request is initiated.
old-password	Yes	Old password to authenticate the user.
new-password	Yes	New password which will replace old-password.

Date	Fri, 08 May 2020 10:51:59 GMT
Content-Type	application/json; charset=UTF-8
Connection	keep-alive
Access-Control-Allow-Origin	*
X-Frame-Options	sameorigin

Field	Required	Description
username		The unique username of the user.
account-status		The current status of the user account. Default value: _active_ Possible values: _active, locked, expired or deactivated_
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_`
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_`
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_`
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_
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_
logged-in		The current logged-in status of the user. Default value: _false_ Possible values: _true or false_
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_
account-lock-period		Amount of time (in minutes) for which user's account gets locked. Default value: _5_ Possible values: _1...65535_
authorization-mode		The mode for user-authorization in priority order.
authentication-mode		The mode for user-authentication in priority order.
group		A list of groups this user is assigned to.
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_`
user-type		Indicates if user is logged in with internal or external policy. Possible values: _internal or external_

Field	Required	Description
user		Required A unique username of the user.
Attribute		Description

Date	Tue, 05 Jan 2021 17:17:31 GMT
Content-Type	application/json;charset=utf-8
Connection	keep-alive
Access-Control-Allow-Origin	*
X-Frame-Options	sameorigin
Strict-Transport-Security	max-age=63072000

Date	Fri, 08 May 2020 12:06:36 GMT
Connection	keep-alive
Access-Control-Allow-Origin	*
X-Frame-Options	sameorigin

Date	Fri, 08 May 2020 12:07:40 GMT
Content-Type	application/json; charset=UTF-8
Connection	keep-alive
Access-Control-Allow-Origin	*
X-Frame-Options	sameorigin

Field	Required	Description
vendor-id		The id of the vendor according to IANA, e.g. 664 for ADTRAN.
vendor-type		The type of the vendor specific attribute, e.g. 2 for ADTRAN-MOSAIC-CP-USER-GROUP.
vendor-value		The value of the vendor specific attribute to match and assign the group(s) below.
group		List of permission group names in MCP that the RADIUS user will be given upon login.

Mosaic CP API Guide

Introduction

Mosaic CP API Guide

Introduction

Administration

Token Management

POSTRequest Token

Notes

Examples

Request

Response

Request

Response

POSTRelease a Session Token

Examples

Request

Response

AAA Config

PATCHModifying Password Security Setting

Examples

Request

Response

Request

Response

Request

Response

Request

Response

Request

Response

Request

Response

GETRetrieve Password Security Setting

Examples

Request

Response

AAA Permission Groups

POSTCreate Group

Examples

Request

Response

Request

Response

Request

Response

DELETEDelete Group

Examples

Request

Response

Request

Response

GETGet Group

Examples

Request

Response

Request

Response

Request

Response

GETGet All Groups

Examples

Request

Response

GETRetrieve Module Permissions

Examples

Request

Response

AAA Users

POSTCreate User Account

Examples

Request

Response

Request

Response

Request

Response

POSTOverride Password

Examples

Request

Response

Access-Control-Allow-Origin	*
Cache-Control	no-store, no-cache, must-revalidate, private
Connection	keep-alive
Content-Security-Policy	default-src 'self' *.adtran.cloud 'unsafe-inline'; style-src 'self' 'unsafe-inline';
Content-Type	application/json;charset=utf-8
Date	Sat, 27 Jun 2026 11:15:01 GMT
Etag	"573172b0-fea1-4a87-a15c-c8bd14f77ab7"
Permissions-Policy	accelerometer=(), ambient-light-sensor=(), autoplay=(), battery=(), camera=(), cross-origin-isolated=(), display-capture=(), document-domain=(), encrypted-media=(), execution-while-not-rendered=(), execution-while-out-of-viewport=(), fullscreen=(), geolocation=(), gyroscope=(), keyboard-map=(), magnetometer=(), microphone=(), midi=(), navigation-override=(), payment=(), picture-in-picture=(), publickey-credentials-get=(), screen-wake-lock=(), sync-xhr=(), usb=(), web-share=(), xr-spatial-tracking=()
Pragma	no-cache
Referrer-Policy	no-referrer
Strict-Transport-Security	max-age=63072000
X-Content-Type-Options	nosniff
X-Frame-Options	sameorigin

Field	Required	Description
vsa-to-permission-group		Required vendor-id,vendor-type,vendor-value
Attribute		Description

Field	Required	Description
method		HTTP method used for request by the user. Possible Values: _get, post, put, patch or delete_
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}_
username		Unique name of the user who sent the request.
uri		URI requested by the user.
status-code		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'.
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_`_._
content		Content or body of request by the user.
ip-address		Origin of the request in the accounting log entry. Possible Formats: _ipv4-address or ipv6-address_
duration-time		Duration of the request in miliseconds.

Field	Required	Description
from-time		Select logs that occurred 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_`_._
to-time		Select logs that occurred 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_`_._
username		Select logs matching the user names given in the list.
min-duration		Select logs for which request's duration is equal or greater than given value. If not present, no lower bound will be used on the duration value. This value should be provided in miliseconds.
max-duration		Select logs for which request's duration is equal or greater than given value. If not present, no lower bound will be used on the duration value. This value should be provided in miliseconds.

Date	Wed, 06 May 2020 06:51:43 GMT
Content-Type	application/json; charset=UTF-8
Connection	keep-alive
Vary	Accept-Encoding
Access-Control-Allow-Origin	*
X-Frame-Options	sameorigin
Content-Encoding	gzip

Field	Required	Description
cursor		Required: Cursor position pointing to next request Possible values: 0-4294967295.
result-size		Number of records to be returned in a single query. Possible values: 0..1000.

Field	Required	Description
> 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` For `include-strict/exclude-strict` search actions, multiple values can be provided. They will be treated as possible set of values ( same as OR boolean operator). For other search actions only first value is used.
sort-by		Used to determine the sequencing of audit logs. Possible values username: Sorts by user name. uri: Sorts by uri of the request. timestamp: Sorts by the timestamp of the request. response: Sorts by the response status code and description. duration: Sorts by the duration of the request.
order-by		Orders audit logs 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._

Field	Required	Description
name	Yes	A user configurable name for the credentials. Upon creation of the credential, the associated name will default to a unique value.
Authenticate Type	Yes	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. _
password-authentication		username : Username for access to the network element. password : Password for access to the network element.
key-authentication		username : Username for access to the network element. key : key for access to the network element.
password-only-authentication		password : Authentication parameters for access without username.

Date	Wed, 06 May 2020 08:50:28 GMT
Connection	keep-alive
Cache-Control	no-store
ETag	"7a4880ce-b67e-4b21-8eb5-02b2d88774f1"
Access-Control-Allow-Origin	*
X-Frame-Options	sameorigin

Date	Wed, 06 May 2020 08:50:49 GMT
Content-Type	application/json; charset=UTF-8
Connection	keep-alive
Access-Control-Allow-Origin	*
X-Frame-Options	sameorigin