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
Expand
NameDescriptionRequiredDefaultPattern

id

 

X

null

 

42.1.1.3. Return Type

StorageNetworkBaseline

42.1.1.4. Content Type

  • application/json

42.1.1.5. Responses

Expand
Table 42.1. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

StorageNetworkBaseline

0

An unexpected error response.

GoogleRpcStatus

42.1.1.6. Samples

42.1.2. GetNetworkBaselineStatusForExternalFlows

GET /v1/networkbaseline/{deploymentId}/status/external

42.1.2.1. Description

42.1.2.2. Parameters

42.1.2.2.1. Path Parameters
Expand
NameDescriptionRequiredDefaultPattern

deploymentId

 

X

null

 
42.1.2.2.2. Query Parameters
Expand
NameDescriptionRequiredDefaultPattern

query

 

-

null

 

since

 

-

null

 

pagination.limit

 

-

null

 

pagination.offset

 

-

null

 

pagination.sortOption.field

 

-

null

 

pagination.sortOption.reversed

 

-

null

 

pagination.sortOption.aggregateBy.aggrFunc

 

-

UNSET

 

pagination.sortOption.aggregateBy.distinct

 

-

null

 

42.1.2.3. Return Type

V1NetworkBaselineExternalStatusResponse

42.1.2.4. Content Type

  • application/json

42.1.2.5. Responses

Expand
Table 42.2. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

V1NetworkBaselineExternalStatusResponse

0

An unexpected error response.

GoogleRpcStatus

42.1.2.6. Samples

42.1.3. GetNetworkBaselineStatusForFlows

POST /v1/networkbaseline/{deploymentId}/status

42.1.3.1. Description

42.1.3.2. Parameters

42.1.3.2.1. Path Parameters
Expand
NameDescriptionRequiredDefaultPattern

deploymentId

 

X

null

 
42.1.3.2.2. Body Parameter
Expand
NameDescriptionRequiredDefaultPattern

body

NetworkBaselineServiceGetNetworkBaselineStatusForFlowsBody

X

  

42.1.3.3. Return Type

V1NetworkBaselineStatusResponse

42.1.3.4. Content Type

  • application/json

42.1.3.5. Responses

Expand
Table 42.3. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

V1NetworkBaselineStatusResponse

0

An unexpected error response.

GoogleRpcStatus

42.1.3.6. Samples

42.1.4. LockNetworkBaseline

PATCH /v1/networkbaseline/{id}/lock

42.1.4.1. Description

42.1.4.2. Parameters

42.1.4.2.1. Path Parameters
Expand
NameDescriptionRequiredDefaultPattern

id

 

X

null

 
42.1.4.2.2. Body Parameter
Expand
NameDescriptionRequiredDefaultPattern

body

object

X

  

42.1.4.3. Return Type

Object

42.1.4.4. Content Type

  • application/json

42.1.4.5. Responses

Expand
Table 42.4. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

Object

0

An unexpected error response.

GoogleRpcStatus

42.1.4.6. Samples

42.1.5. ModifyBaselineStatusForPeers

PATCH /v1/networkbaseline/{deploymentId}/peers

42.1.5.1. Description

42.1.5.2. Parameters

42.1.5.2.1. Path Parameters
Expand
NameDescriptionRequiredDefaultPattern

deploymentId

 

X

null

 
42.1.5.2.2. Body Parameter
Expand
NameDescriptionRequiredDefaultPattern

body

NetworkBaselineServiceModifyBaselineStatusForPeersBody

X

  

42.1.5.3. Return Type

Object

42.1.5.4. Content Type

  • application/json

42.1.5.5. Responses

Expand
Table 42.5. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

Object

0

An unexpected error response.

GoogleRpcStatus

42.1.5.6. Samples

42.1.6. UnlockNetworkBaseline

PATCH /v1/networkbaseline/{id}/unlock

42.1.6.1. Description

42.1.6.2. Parameters

42.1.6.2.1. Path Parameters
Expand
NameDescriptionRequiredDefaultPattern

id

 

X

null

 
42.1.6.2.2. Body Parameter
Expand
NameDescriptionRequiredDefaultPattern

body

object

X

  

42.1.6.3. Return Type

Object

42.1.6.4. Content Type

  • application/json

42.1.6.5. Responses

Expand
Table 42.6. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

Object

0

An unexpected error response.

GoogleRpcStatus

42.1.6.6. Samples

Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat Documentation

Legal Notice

Theme

© 2026 Red Hat
Back to top