Chapter 42. Network Baseline Service
42.1. Network Baseline Service
42.1.1. GetNetworkBaseline
GET /v1/networkbaseline/{id}
42.1.1.1. Description
42.1.1.2. Parameters
42.1.1.2.1. Path Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
id | X | null |
42.1.1.3. Return Type
42.1.1.4. Content Type
- application/json
42.1.1.5. Responses
Code | Message | Datatype |
---|---|---|
200 | A successful response. | |
0 | An unexpected error response. |
42.1.1.6. Samples
42.1.2. GetNetworkBaselineStatusForFlows
POST /v1/networkbaseline/{deploymentId}/status
42.1.2.1. Description
42.1.2.2. Parameters
42.1.2.2.1. Path Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
deploymentId | X | null |
42.1.2.2.2. Body Parameter
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
body | X |
42.1.2.3. Return Type
42.1.2.4. Content Type
- application/json
42.1.2.5. Responses
Code | Message | Datatype |
---|---|---|
200 | A successful response. | |
0 | An unexpected error response. |
42.1.2.6. Samples
42.1.3. LockNetworkBaseline
PATCH /v1/networkbaseline/{id}/lock
42.1.3.1. Description
42.1.3.2. Parameters
42.1.3.2.1. Path Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
id | X | null |
42.1.3.2.2. Body Parameter
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
body |
| X |
42.1.3.3. Return Type
Object
42.1.3.4. Content Type
- application/json
42.1.3.5. Responses
Code | Message | Datatype |
---|---|---|
200 | A successful response. |
|
0 | An unexpected error response. |
42.1.3.6. Samples
42.1.4. ModifyBaselineStatusForPeers
PATCH /v1/networkbaseline/{deploymentId}/peers
42.1.4.1. Description
42.1.4.2. Parameters
42.1.4.2.1. Path Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
deploymentId | X | null |
42.1.4.2.2. Body Parameter
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
body | X |
42.1.4.3. Return Type
Object
42.1.4.4. Content Type
- application/json
42.1.4.5. Responses
Code | Message | Datatype |
---|---|---|
200 | A successful response. |
|
0 | An unexpected error response. |
42.1.4.6. Samples
42.1.5. UnlockNetworkBaseline
PATCH /v1/networkbaseline/{id}/unlock
42.1.5.1. Description
42.1.5.2. Parameters
42.1.5.2.1. Path Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
id | X | null |
42.1.5.2.2. Body Parameter
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
body |
| X |
42.1.5.3. Return Type
Object
42.1.5.4. Content Type
- application/json
42.1.5.5. Responses
Code | Message | Datatype |
---|---|---|
200 | A successful response. |
|
0 | An unexpected error response. |