domain_name_based_applications¶
Overview¶
API to add, delete, get, modify custom domain details
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/config_editor/
Schemes : HTTP
Tags¶
- domain_name_based_applications : Operations related to domain_name_based_applications
Paths¶
POST operation for domain_name_based_applications¶
POST /domain_name_based_applications
Description¶
Use this operation to add Domain Based Application globally
Parameters¶
| Type | Name | Schema |
|---|---|---|
| Body | body optional |
domain_name_based_applications_request_schema |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource successfully added | domain_name_based_applications_post_success_schema |
| 400 | Failed: bad input parameter | ErrorSchema |
| 401 | Unauthorized: Failed Authentication | ErrorSchema |
| 403 | Unauthorized: Forbidden | ErrorSchema |
| 405 | Failed: Data format unacceptable | ErrorSchema |
| 415 | Failed: Data format unacceptable | ErrorSchema |
| 500 | Failed: Internal Server Error | ErrorSchema |
Consumes¶
application/json
Produces¶
application/json
Tags¶
- domain_name_based_applications
Get operation for domain_name_based_applications¶
GET /domain_name_based_applications
Description¶
Use this operation to get the global Domain Based Application configured
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | domain_name_based_applications_response_schema |
| 400 | Failed: bad input parameter | ErrorSchema |
| 401 | Unauthorized: Failed Authentication | ErrorSchema |
| 403 | Unauthorized: Forbidden | ErrorSchema |
| 405 | Failed: Data format unacceptable | ErrorSchema |
| 415 | Failed: Data format unacceptable | ErrorSchema |
| 500 | Failed: Internal Server Error | ErrorSchema |
Produces¶
application/json
Tags¶
- domain_name_based_applications
PUT operation for domain_name_based_applications¶
PUT /domain_name_based_applications
Description¶
Use this operation to modify Domain Based Application
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource modified added | domain_name_based_applications_put_success_schema |
| 400 | Failed: bad input parameter | ErrorSchema |
| 401 | Unauthorized: Failed Authentication | ErrorSchema |
| 403 | Unauthorized: Forbidden | ErrorSchema |
| 405 | Failed: Data format unacceptable | ErrorSchema |
| 415 | Failed: Data format unacceptable | ErrorSchema |
| 500 | Failed: Internal Server Error | ErrorSchema |
Produces¶
application/json
Tags¶
- domain_name_based_applications
DELETE operation for domain_name_based_applications¶
DELETE /domain_name_based_applications/{deletePathParam}
Description¶
Use this operation to delete Domain Based Application configured
Parameters¶
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | deletePathParam required |
Object Primary Key for DELETE operation | object |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource delete added | domain_name_based_applications_delete_success_schema |
| 400 | Failed: bad input parameter | ErrorSchema |
| 401 | Unauthorized: Failed Authentication | ErrorSchema |
| 403 | Unauthorized: Forbidden | ErrorSchema |
| 405 | Failed: Data format unacceptable | ErrorSchema |
| 415 | Failed: Data format unacceptable | ErrorSchema |
| 500 | Failed: Internal Server Error | ErrorSchema |
Produces¶
application/json
Tags¶
- domain_name_based_applications
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
application_domain_details¶
domain name
Type : < application_domain_details > array
| Name | Description | Schema |
|---|---|---|
| domain_name optional |
The name of the domain | string |
| id optional |
Auto-generated ID to uniquely identify domain name | integer |
domain_name_based_applications¶
| Name | Schema |
|---|---|
| application_domain_details optional |
application_domain_details |
| id optional |
id |
| name optional |
name |
| package_name optional |
package_name |
domain_name_based_applications_delete_success_schema¶
| Name | Schema |
|---|---|
| domain_name_based_applications optional |
domain_name_based_applications |
domain_name_based_applications
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
domain_name_based_applications_post_success_schema¶
| Name | Schema |
|---|---|
| domain_name_based_applications optional |
domain_name_based_applications |
domain_name_based_applications
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
domain_name_based_applications_put_success_schema¶
| Name | Schema |
|---|---|
| domain_name_based_applications optional |
domain_name_based_applications |
domain_name_based_applications
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
domain_name_based_applications_request_schema¶
| Name | Schema |
|---|---|
| domain_name_based_applications optional |
domain_name_based_applications |
domain_name_based_applications_response_schema¶
Type : < domain_name_based_applications_response_schema > array
domain_name_based_applications_response_schema
| Name | Schema |
|---|---|
| application_domain_details optional |
application_domain_details |
| id optional |
id |
| name optional |
name |
| package_name optional |
package_name |
id¶
Auto-generated ID to uniquely identify Domain Based Application
Type : integer
name¶
The name of the Domain Based Application
Type : string
package_name¶
Config package name using which the API operation should be performed.
Type : string