Mosaic One

https://help.m1.adtran.cloud/docs/
Admin
Mosaic One is an ADTRAN cloud platform that provides applications for care, operations, and...
Tokens:34,952
Snippets:98
Trust Score:5.6
Update:1 year ago
Show doc for...
Tokens:
Raw
### Get Subscriber Daily Peak Bandwidth C# Example

Source: https://help.m1.adtran.cloud/docs/api/reference/get-subscriber-daily-peak-bandwidth-by-account-number-and-service-index

This C# code example demonstrates how to make a GET request to the Adtran Cloud API to fetch subscriber daily peak bandwidth. It includes setting up HttpClient, adding necessary headers like Accept and X-API-Key, sending the request, and handling the response.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://help.m1.adtran.cloud");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-API-Key", "<X-API-Key>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### ADTRAN Cloud API Service Response Example

Source: https://help.m1.adtran.cloud/docs/api/user-guide

An example JSON response from the ADTRAN Cloud API detailing a subscriber's service, including home network (gateway, devices, mesh nodes) and access network (ONU, OLT, service actions) information.

```json
{
"home-network":{
"gateway":{
"equipment-type":"RESIDENTIAL_GATEWAY",
"name":"ROOM 1",
"ssid":"Example Subscriber's Wifi",
"part-number":"PP403Z",
"serial-number":"EB85B00CDD",
"wan-ip":null,
"wan-mac":"e4:c0:e2:21:db:68",
"ip-addresses":[
"192.168.1.174",
"207.229.97.200",
"fe80::e6c0:e2ff:fe21:db68/64",
"fd41:2754:bfd6::549/128",
"fd41:2754:bfd6:0:e6c0:e2ff:fe21:db68/64"
],
"public-ip":"207.229.97.200",
"vendor":"Plume",
"software-version":"6.4.1-35-gf5f999-prod",
"hardware-version":"6.4.1-35-gf5f999-prod",
"booted-at":"2024-12-12T18:54:47.000Z",
"uptime":441415,
"oper-state":"UNKNOWN"
},
"devices":[
{
"hostname":"Amazon Echo",
"ip-addresses":[
"192.168.1.179"
],
"mac-address":"20:a1:71:0b:eb:25",
"oper-state":"UP",
"connection-type":"WIFI",
"upstream-rssi":-59,
"brand":"Amazon",
"connected-to":"EB85B00CDD",
"connection-state-change-at":"2024-12-15T21:25:36.636Z",
"device-source":"PLUME",
"wifi-generation":"UNAVAILABLE",
"wifi-standard":"UNAVAILABLE",
"device-link":"https://adtran.gamma.central.plume.com/customer/652555d7fcc9fe000bdae81e/location/652555d7fcc9fe000bdae81f/devices/20:a1:71:0b:eb:25"
},
{
"hostname":"Adtran 4b:41:11",
"ip-addresses":[],
"mac-address":"cc:66:18:4b:41:11",
"oper-state":"DOWN",
"connection-type":"WIRED",
"upstream-rssi":null,
"brand":null,
"connected-to":null,
"connection-state-change-at":"2024-12-06T03:13:46.000Z",
"device-source":"PLUME",
"wifi-generation":"UNAVAILABLE",
"wifi-standard":"UNAVAILABLE",
"device-link":"https://adtran.gamma.central.plume.com/customer/652555d7fcc9fe000bdae81e/location/652555d7fcc9fe000bdae81f/devices/cc:66:18:4b:41:11"
}
],
"mesh-nodes":[
{
"serial-number":"LC8AE0002F",
"name":"ROOM 2",
"backhaul-type":"WIFI",
"device-model":"PP603X",
"ip-addresses":[
"192.168.1.168",
"207.229.97.200",
"fd41:2754:bfd6:0:7c9f:7ff:fedd:3899/64",
"fd41:2754:bfd6::80f/128",
"fe80::7c9f:7ff:fedd:3899/64"
],
"mac-address":"7c:9f:07:dd:38:99",
"connection-state":"CONNECTED",
"connected-device-count":0,
"connection-state-change-at":"2024-12-12T18:56:33.884Z",
"rssi":-52,
"device-link":"https://adtran.gamma.central.plume.com/customer/652555d7fcc9fe000bdae81e/location/652555d7fcc9fe000bdae81f/nodes/LC8AE0002F"
}
]
},
"access-network":{
"onu":{
"light-levels":{
"rx":-20.1,
"rx-retrieved-on":"2024-12-17 21:31:42",
"rx-state":"GOOD",
"tx":3.9,
"tx-retrieved-on":"2024-12-17 21:31:42",
"tx-state":"GOOD"
},
"serial-number":"ADTN17271254"
},
"olt":{
"light-levels":{
"rx":-20.0,
"rx-retrieved-on":"2024-12-17 21:31:42",
"rx-state":"GOOD",
"tx":3.8,
"tx-retrieved-on":"2024-12-17 21:31:42",
"tx-state":"GOOD"
}
},
"admin-state":"ENABLED",
"admin-state-retrieved-on":"2024-12-17 21:31:42",
"oper-state":"UP",
"oper-state-retrieved-on":"2024-12-17 21:31:42"
},
"service-actions":{
"reboot-rg":"https://us.m1api.adtran.cloud/subscribers/account-number=54322/service=ab3b9569-defb-4b05-8ad7-b41dcfedf3ca/reboot-rg",
"reboot-circuit":"https://us.m1api.adtran.cloud/subscribers/account-number=54322/service=ab3b9569-defb-4b05-8ad7-b41dcfedf3ca/reboot-circuit"
}
}
}
```

--------------------------------

### C# HttpClient Example for Get Subscriber Service Actions

Source: https://help.m1.adtran.cloud/docs/api/reference/get-subscriber-service-actions-by-account-number-and-service-index

This C# code snippet demonstrates how to use HttpClient to make a GET request to the Adtran Cloud API for subscriber service actions. It includes setting the API key and accepting JSON content.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://help.m1.adtran.cloud");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-API-Key", "<X-API-Key>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Reboot Circuit C# Example

Source: https://help.m1.adtran.cloud/docs/api/reference/post-reboot-circuit-by-account-number-and-service-index

An example using C# HttpClient to call the Post Reboot Circuit API. It demonstrates setting the request method, URL, headers (Accept, X-API-Key), sending the request, and handling the response.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://help.m1.adtran.cloud/subscribers/account-number=<account-number>/service=<service-index>/reboot-circuit");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-API-Key", "<X-API-Key>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### C# HttpClient Example for Adtran Cloud API

Source: https://help.m1.adtran.cloud/docs/api/reference/get-subscriber-service-by-account-number-and-service-index

Demonstrates how to use C#'s HttpClient to make a GET request to the Adtran Cloud API, including setting headers for authentication and content negotiation.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://help.m1.adtran.cloud");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-API-Key", "<X-API-Key>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Example Subscriber Data Response from Mosaic One API

Source: https://help.m1.adtran.cloud/docs/api/user-guide

This JSON object represents a successful response from the Mosaic One API when retrieving subscriber information. It includes details such as subscriber ID, account number, address, and service information.

```JSON
{
"subscriber-id":"0a1982a5-7489-43f1-b350-e04e40d4dcc5",
"name":"Subscriber, Example",
"account-number":"54322",
"address":"123 Example Way",
"city":"Madison",
"state":"AL",
"zip-code":"35758",
"phone-number":"1012227788",
"care-url":"https://m1.adtran.cloud/dashboard/adtran/care/subscriber/m1/0a1982a5-7489-43f1-b350-e04e40d4dcc5",
"subscriber-type":"RESIDENTIAL",
"service-count":1,
"services":[
{
"service-id":"ab3b9569-defb-4b05-8ad7-b41dcfedf3ca",
"service-url":"https://us.m1api.adtran.cloud/subscribers/account-number=54322/status/service=ab3b9569-defb-4b05-8ad7-b41dcfedf3ca",
"service-type":"BROADBAND",
"package-name":"INT16R 19.2M/1.2M",
"provisioned-downstream-rate":19200000,
"provisioned-upstream-rate":1200000,
"max-attainable-downstream-rate":null,
"max-attainable-upstream-rate":null,
"service-address-street-address":"123 Example Way",
"service-address-city":"Madison",
"service-address-state":"AL",
"service-address-zip":"35758"
}
]
}
```

--------------------------------

### Authorize Adtran Cloud API with X-API-Key (HTTP)

Source: https://help.m1.adtran.cloud/docs/api/reference/get-subscriber-by-email

Provides an example of an HTTP GET request to the Adtran Cloud API's 'subscribers/by-email' endpoint, including the necessary 'Accept' and 'X-API-Key' headers for authentication.

```http
GET /subscribers/by-email HTTP/1.1
Host: help.m1.adtran.cloud
Accept: application/json
X-API-Key: <X-API-Key>
```

--------------------------------

### Get Speed Test Results (C#)

Source: https://help.m1.adtran.cloud/docs/api/reference/get-speed-test-by-test-id

Example C# code to fetch speed test results from the Adtran Cloud API. It demonstrates setting up an HttpClient, constructing the request with the correct endpoint and headers (including the API key), sending the request, and processing the response.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://help.m1.adtran.cloud/speed-test/test-id=<test_id>");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-API-Key", "<X-API-Key>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Start Speed Test - Adtran Cloud API

Source: https://help.m1.adtran.cloud/docs/api/reference

Initiates a speed test for a device associated with a subscriber. This allows for on-demand performance testing of the network connection.

```shell
POST /api/v1/speedtest/{subscriberId}
```

--------------------------------

### Get Subscriber - Not Found Response (404)

Source: https://help.m1.adtran.cloud/docs/api/reference/get-subscriber-by-account-number

This example displays the response format for a 'resource not found' error (HTTP 404) when calling the 'Get Subscriber' API. It means the specified subscriber or resource could not be located.

```JSON
{
  "message": "string",
  "statusCode": 404
}
```

--------------------------------

### Get Subscriber Service Actions Response Schema (Success)

Source: https://help.m1.adtran.cloud/docs/api/reference/get-subscriber-service-actions-by-account-number-and-service-index

This JSON schema defines the structure of a successful response for the Get Subscriber Service Actions API. It includes 'reboot-rg' and 'reboot-circuit' which return a URL or an 'Insufficient Permissions' message.

```json
{
"reboot-rg":"string",
"reboot-circuit":"string"
}
```

--------------------------------

### Get Subscriber Service Actions Response Schema (Not Found)

Source: https://help.m1.adtran.cloud/docs/api/reference/get-subscriber-service-actions-by-account-number-and-service-index

This JSON schema describes the response when a resource is not found (status code 404). It includes a 'message' and the 'statusCode'.

```json
{
"message":"string",
"statusCode":404
}
```

--------------------------------

### Get Subscriber Service Actions API Endpoint

Source: https://help.m1.adtran.cloud/docs/api/reference/get-subscriber-service-actions-by-account-number-and-service-index

This snippet shows the GET request path for retrieving subscriber service actions. It requires the account number and service index as path parameters.

```http
GET
## /subscribers/account-number=:account-number/status/service=:service-index/actions
```

--------------------------------

### Get Subscriber Service Actions - Adtran Cloud API

Source: https://help.m1.adtran.cloud/docs/api/reference

Returns a list of actions that can be performed by the API key for a subscriber's service. This helps in understanding the available management capabilities for a subscriber.

```shell
GET /api/v1/subscriber/{subscriberId}/actions
```

--------------------------------

### Authorize Adtran Cloud API with X-API-Key (C#)

Source: https://help.m1.adtran.cloud/docs/api/reference/get-subscriber-by-email

Demonstrates how to make an authenticated GET request to the Adtran Cloud API's 'subscribers/by-email' endpoint using C#. It shows how to add the 'X-API-Key' and 'Accept' headers to the HttpClient request.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://help.m1.adtran.cloud/subscribers/by-email");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-API-Key", "<X-API-Key>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Authorize Adtran Cloud API with X-API-Key (C#)

Source: https://help.m1.adtran.cloud/docs/api/reference/get-subscriber-by-account-number

This snippet shows how to make a GET request to the Adtran Cloud API, including the 'X-API-Key' in the request headers for authorization. It uses HttpClient to send the request and handle the response.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://help.m1.adtran.cloud");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-API-Key", "<X-API-Key>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Get Subscriber Service Actions Response Schema (Unauthorized)

Source: https://help.m1.adtran.cloud/docs/api/reference/get-subscriber-service-actions-by-account-number-and-service-index

This JSON schema outlines the response for an unauthorized request (status code 401). It includes a 'message' and the 'statusCode'.

```json
{
"message":"string",
"statusCode":401
}
```

--------------------------------

### Get Subscriber - Unauthorized Response (401)

Source: https://help.m1.adtran.cloud/docs/api/reference/get-subscriber-by-account-number

This example shows the response structure for an unauthorized request (HTTP 401) to the 'Get Subscriber' API. It indicates that the request lacks valid authentication credentials.

```JSON
{
  "message": "string",
  "statusCode": 401
}
```

--------------------------------

### Get Subscriber - Forbidden Response (403)

Source: https://help.m1.adtran.cloud/docs/api/reference/get-subscriber-by-account-number

This example illustrates the response for a forbidden request (HTTP 403) to the 'Get Subscriber' API. It signifies that the authenticated user does not have permission to access the requested resource.

```JSON
{
  "message": "string",
  "statusCode": 403
}
```

--------------------------------

### Get Subscriber - Validation Error Response (422)

Source: https://help.m1.adtran.cloud/docs/api/reference/get-subscriber-by-account-number

This example details the response structure for a validation error (HTTP 422) when using the 'Get Subscriber' API. It provides specific information about which fields failed validation and why.

```JSON
{
  "statusCode": 422,
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
```

--------------------------------

### Initiate Speed Test (HTTP)

Source: https://help.m1.adtran.cloud/docs/api/reference/post-speed-test-by-account-number-and-service-index

This snippet demonstrates how to initiate a speed test using an HTTP POST request. It includes the endpoint URL, required path parameters (account-number, service-index), and the necessary header parameter (X-Tenant).

```http
POST /subscribers/account-number=<account-number>/service=<service-index>/speed-test

--header "X-Tenant: <Tenant ID>"
```

--------------------------------

### Retrieve Service Information via API

Source: https://help.m1.adtran.cloud/docs/api/user-guide

Fetches detailed information for a specific service using its unique identifier. Requires API key and tenant headers for authentication. The response includes various network and device details.

```bash
curl --location 'https://us.m1api.adtran.cloud/subscribers/account-number=54322/status/service=ab3b9569-defb-4b05-8ad7-b41dcfedf3ca' \
--header 'X-Api-Key: ads2s_12ad34tr56an78_zy09xw87vu65ts43rq21po01' \
--header 'X-Tenant: adtran'
```

--------------------------------

### Get Subscriber - Method Not Allowed Response (405)

Source: https://help.m1.adtran.cloud/docs/api/reference/get-subscriber-by-account-number

This example shows the response for an invalid HTTP method used to access the 'Get Subscriber' API (HTTP 405). It indicates that the requested HTTP method is not supported for this endpoint.

```JSON
{
  "message": "string",
  "statusCode": 405
}
```

--------------------------------

### Initiate Speed Test (C# HttpClient)

Source: https://help.m1.adtran.cloud/docs/api/reference/post-speed-test-by-account-number-and-service-index

This C# code example shows how to use HttpClient to send a POST request to the 'Post Speed Test' API endpoint. It configures the request with the correct HTTP method, URL, and adds the required 'Accept' and 'X-API-Key' headers.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://help.m1.adtran.cloud/subscribers/account-number=<account-number>/service=<service-index>/speed-test");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-API-Key", "<X-API-Key>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Get Subscriber - Successful Response (200)

Source: https://help.m1.adtran.cloud/docs/api/reference/get-subscriber-by-account-number

This example demonstrates a successful response (HTTP 200) from the 'Get Subscriber' API. It returns a JSON object containing detailed subscriber information, including personal details, service information, and associated URLs.

```JSON
{
  "subscriber-id": "string",
  "name": "",
  "account-number": "",
  "address": "",
  "city": "",
  "state": "",
  "zip-code": "",
  "phone-number": "",
  "care-url": "string",
  "msi-url": "string",
  "subscriber-type": "RESIDENTIAL",
  "service-count": 0,
  "services": [
    {
      "service-id": "string",
      "service-url": "string",
      "service-type": "BROADBAND",
      "service-account-number": "string",
      "package-name": "string",
      "provisioned-downstream-rate": 0,
      "provisioned-upstream-rate": 0,
      "max-attainable-downstream-rate": 0,
      "max-attainable-upstream-rate": 0,
      "service-address-street-address": "string",
      "service-address-city": "string",
      "service-address-state": "string",
      "service-address-zip": "string",
      "site-name": "string",
      "site-ip": "string",
      "port-description": "string",
      "wan-mac": "string"
    }
  ]
}
```

--------------------------------

### Execute Service Reboot Action via API

Source: https://help.m1.adtran.cloud/docs/api/user-guide

Initiates a reboot action for a specific service using a POST request to the designated API endpoint. Requires elevated API key permissions and includes tenant and API key headers.

```bash
curl --location 'https://us.m1api.adtran.cloud/subscribers/account-number=54322/service=ab3b9569-defb-4b05-8ad7-b41dcfedf3ca/reboot-rg' \
-X POST \
--header 'X-Api-Key: ads2s_12ad34tr56an78_zy09xw87vu65ts43rq21po01' \
--header 'X-Tenant: adtran'
```

--------------------------------

### Reboot RG using HttpClient (C#)

Source: https://help.m1.adtran.cloud/docs/api/reference/post-reboot-rg-by-account-number-and-service-index

This C# code snippet demonstrates how to reboot a Residential Gateway (RG) using the HttpClient class. It sends a POST request to the '/subscribers/account-number=<account-number>/service=<service-index>/reboot-rg' endpoint, including necessary headers for authentication and content negotiation. The code ensures the request is successful and prints the response content.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://help.m1.adtran.cloud/subscribers/account-number=<account-number>/service=<service-index>/reboot-rg");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-API-Key", "<X-API-Key>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Post Reboot Circuit API Endpoint

Source: https://help.m1.adtran.cloud/docs/api/reference/post-reboot-circuit-by-account-number-and-service-index

This snippet shows the HTTP POST request structure for the /subscribers/account-number=<account-number>/service=<service-index>/reboot-circuit API endpoint. It requires account-number and service-index as path parameters and X-Tenant as a header parameter.

```HTTP
POST /subscribers/account-number=<account-number>/service=<service-index>/reboot-circuit
```

--------------------------------

### Import Users from CSV in Okta

Source: https://help.m1.adtran.cloud/docs/administration/okta/administration-of-users-in-okta

This guide explains how to import users into Okta using a CSV file, allowing for bulk creation or updates. It includes downloading a template, filling user attributes, uploading the file, and handling validation and activation settings.

```Okta Admin Console
1. Navigate to Admin Console.
2. Go to Directory > People.
3. Select 'More Actions', then choose 'Import Users From CSV'.
4. Download the template CSV file.
5. Complete attribute fields (login, firstName, lastName, email).
6. Upload CSV.
7. Correct errors or note success, then select 'Next'.
8. Enable 'Automatically activate new users' if desired.
9. Select 'Import Users'.
```

```CSV
login,firstName,lastName,email
user1,John,Doe,john.doe@example.com
user2,Jane,Smith,jane.smith@example.com
```

--------------------------------

### View Chart Data Options

Source: https://help.m1.adtran.cloud/docs/operate/node-details

Describes additional options available for interacting with chart data, such as viewing in full screen, printing, or viewing the raw data table.

```UI Interaction
View in full screen
Print chart
View data table
```

--------------------------------

### Get Subscriber API Endpoint

Source: https://help.m1.adtran.cloud/docs/api/reference/get-subscriber-by-account-number

This snippet shows the basic structure for calling the 'Get Subscriber' API endpoint. It requires an account number in the path and a tenant ID in the headers to retrieve subscriber information.

```REST
GET /subscribers/account-number=:account-number
Header: X-Tenant: <Tenant ID>
```

--------------------------------

### Get Subscriber Service Status API Endpoint

Source: https://help.m1.adtran.cloud/docs/api/reference/get-subscriber-service-by-account-number-and-service-index

This snippet shows the GET request format for retrieving a subscriber's service status from the Adtran Cloud API. It specifies the endpoint path and required parameters.

```http
GET /subscribers/account-number=:account-number/status/service=:service-index
```

--------------------------------

### Get Subscriber by Email API Request

Source: https://help.m1.adtran.cloud/docs/api/reference/get-subscriber-by-email

This snippet demonstrates how to make a GET request to retrieve subscriber details using their email address. It requires the subscriber's email as a query parameter and a Tenant ID in the header.

```http
GET ## /subscribers/by-email

### Query Parameters
**email** stringrequired
**Default value:**`false`

### Header Parameters
**X-Tenant** Tenant IDrequired
```

--------------------------------

### Toggle Bandwidth Utilization Data Display

Source: https://help.m1.adtran.cloud/docs/operate/node-details

Allows users to toggle the display of ingress and egress bandwidth utilization data on the 'SM A/B Bandwidth Utilization' charts by selecting legend items.

```UI Interaction
Select "% Egress Util" (or the green colored dot) to toggle the display of egress data on and off.
Select "% Ingress Util" (or the blue colored dot) to toggle the display of ingress data on and off.
```

--------------------------------

### Export Table Data to CSV

Source: https://help.m1.adtran.cloud/docs/promote/upgrade-candidates-report

Initiates the export of the 'Upgrade Candidates' table data to a CSV file. This action triggers a standard save dialogue for the user to choose a download location.

```UI Interaction
Select the blue, rounded **Export** button just beneath the table title to export the data to CSV format. A common save dialogue will appear so that you can choose where the file will be saved on your local hard drive.
```

--------------------------------

### Get Subscriber Daily Peak Bandwidth API Endpoint

Source: https://help.m1.adtran.cloud/docs/api/reference/get-subscriber-daily-peak-bandwidth-by-account-number-and-service-index

This snippet shows the GET request endpoint for retrieving a subscriber's daily peak bandwidth. It requires account number and service index as path parameters and a tenant ID in the header.

```HTTP
GET
## /subscribers/account-number=:account-number/status/service=:service-index/peak-bandwidth
```

--------------------------------

### Add User in Okta

Source: https://help.m1.adtran.cloud/docs/administration/okta/administration-of-users-in-okta

Manually add a new user to your organization in Okta. This process involves filling out user details, assigning groups, and setting password options. The user will then receive an activation email.

```Okta Admin Console
1. Using the Okta URL provided to you in the activation email referenced above, login and navigate to the **Admin Console**. (The URL will resemble https://Adtran-YOUR_COMPANY_NAME_HERE.okta.com.)
2. In the **Admin Console** , go to Directory > People.
3. Select **Add Person**.
4. Accept the default **User type**.
5. Complete the remaining fields as follows:
  * **First name** — Enter the user's first name.
  * **Last name** — Enter the user's last name.
  * **Username** — Enter the user's user name in email format.
  * **Primary email** — Enter the user's primary email if it's different from their username.
  * **Secondary email** — (Optional) Enter a secondary email to allow the user to access information when their primary email is unavailable.
  * **Groups** — This field is pre-populated with the correct, default group. Continue to the next field.
  * **Password** — Select Set by user to allow the user to set their password. (The Set by admin option is not recommended.)
  * **Send user activation now** - (Optional) This check box is available when Set by user is selected as the password option. Select this check box to send a user activation email to the user.
  * **User must change password on first login** — This check box is selected by default when you select **Set by admin** as the password option. It is recommended to accept this default.
6. Select the **Save** button or select **Save and Add Another** to add another user.
7. The users receives an activation email that contains a link and instructions how to proceed.
```

--------------------------------

### Method Not Allowed Response Schema (JSON)

Source: https://help.m1.adtran.cloud/docs/api/reference/get-speed-test-by-test-id

Defines the structure for an 'Operation Not Allowed' error response. This indicates that the HTTP method used (e.g., GET) is not supported for the requested resource.

```json
{
  "message": "string",
  "statusCode": 405
}
```

--------------------------------

### Get Subscriber Service Actions Response Schema (Forbidden)

Source: https://help.m1.adtran.cloud/docs/api/reference/get-subscriber-service-actions-by-account-number-and-service-index

This JSON schema details the response for a forbidden request (status code 403). It includes a 'message' and the 'statusCode'.

```json
{
"message":"string",
"statusCode":403
}
```

--------------------------------

### Export Chart Data Formats

Source: https://help.m1.adtran.cloud/docs/operate/node-details

Lists the available file formats for exporting chart data from the Adtran Cloud interface, including image and data file types.

```UI Interaction
SVG: Scalable Vector Graphics, an image file format
PNG: Portable Network Graphics, an image file format
JPG: Joint Photographic Experts Group, an image file format
CSV: A comma-separated, raw text file
XLS: Microsoft Excel format
```

--------------------------------

### Churn Suspects Table Columns

Source: https://help.m1.adtran.cloud/docs/promote/churn-suspects-report

This describes the columns available in the Churn Suspects table, providing details on the data each column represents for each subscriber.

```text
Full Name: The first and last name of the subscriber.
Account Number: The account number associated with the subscriber.
Service Type: The medium by which this subscriber is serviced. Possible values for this column are: Broadband, Cable, Wireless
Site Name: The name of the chassis that services this subscriber.
Package: The name of the subscription plan to which this customer currently subscribes.
Download Speed (Mbps): The download speed associated with the subscription rate for this subscriber.
Upload Speed (Mbps): The upload speed associated with the subscription rate for this subscriber.
Flight Risk: A ranking of this subscriber's probability of flight risk. Values for this column are High, Medium, Medium-High and Low.
```

--------------------------------

### Get Subscriber Service Actions Response Schema (Operation Not Allowed)

Source: https://help.m1.adtran.cloud/docs/api/reference/get-subscriber-service-actions-by-account-number-and-service-index

This JSON schema defines the response for an operation that is not allowed (status code 405). It includes a 'message' and the 'statusCode'.

```json
{
"message":"string",
"statusCode":405
}
```

--------------------------------

### Export OLT Data Options

Source: https://help.m1.adtran.cloud/docs/operate/olt-details

Lists the available file formats for exporting data from the OLT details page, including image and data file types.

```text
SVG: Scalable Vector Graphics, an image file format
PNG: Portable Network Graphics, an image file format
JPG: Joint Photographic Experts Group, an image file format
CSV: A comma-separated, raw text file
XLS: Microsoft Excel format
```
Tokens:
Raw