SupportConsoleDevelopersStart a trialContact

Chapter 13. ComplianceManagementService

13.1. GetRecentRuns
Copy link

GET /v1/complianceManagement/runs

13.1.1. Description
Copy link

13.1.2. Parameters
Copy link

13.1.2.1. Query Parameters
Copy link

Expand
NameDescriptionRequiredDefaultPattern

clusterId

 

-

null

 

standardId

 

-

null

 

since

 

-

null

 

13.1.3. Return Type
Copy link

V1GetRecentComplianceRunsResponse

13.1.4. Content Type
Copy link

  • application/json

13.1.5. Responses
Copy link

Expand
Table 13.1. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

V1GetRecentComplianceRunsResponse

0

An unexpected error response.

RuntimeError

13.1.6. Samples
Copy link

13.1.7. Common object reference
Copy link

13.1.7.1. ProtobufAny
Copy link

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++. 

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

Example 2: Pack and unpack a message in Java. 

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}
 
Example 3: Pack and unpack a message in Python.
 
foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...
 
Example 4: Pack and unpack a message in Go
 
foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

13.1.7.1.1. JSON representation
Copy link

The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example: 

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}
 
{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]): 

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
Expand
Field NameRequiredNullableTypeDescriptionFormat

typeUrl

  

String

A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL’s path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading \".\" is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, https is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

 

value

  

byte[]

Must be a valid serialized protocol buffer of the above specified type.

byte

13.1.7.2. RuntimeError
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

error

  

String

  

code

  

Integer

 

int32

message

  

String

  

details

  

List of ProtobufAny

  

13.1.7.3. V1ComplianceRun
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

id

  

String

  

clusterId

  

String

  

standardId

  

String

  

startTime

  

Date

 

date-time

finishTime

  

Date

 

date-time

state

  

V1ComplianceRunState

 

INVALID, READY, STARTED, WAIT_FOR_DATA, EVALUTING_CHECKS, FINISHED,

errorMessage

  

String

  

13.1.7.4. V1ComplianceRunState
Copy link

Expand
Enum Values

INVALID

READY

STARTED

WAIT_FOR_DATA

EVALUTING_CHECKS

FINISHED

13.1.7.5. V1GetRecentComplianceRunsResponse
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

complianceRuns

  

List of V1ComplianceRun

  

13.2. TriggerRuns
Copy link

POST /v1/compliancemanagement/runs

13.2.1. Description
Copy link

13.2.2. Parameters
Copy link

13.2.2.1. Body Parameter
Copy link

Expand
NameDescriptionRequiredDefaultPattern

body

V1TriggerComplianceRunsRequest

X

  

13.2.3. Return Type
Copy link

V1TriggerComplianceRunsResponse

13.2.4. Content Type
Copy link

  • application/json

13.2.5. Responses
Copy link

Expand
Table 13.2. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

V1TriggerComplianceRunsResponse

0

An unexpected error response.

RuntimeError

13.2.6. Samples
Copy link

13.2.7. Common object reference
Copy link

13.2.7.1. ProtobufAny
Copy link

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++. 

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

Example 2: Pack and unpack a message in Java. 

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}
 
Example 3: Pack and unpack a message in Python.
 
foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...
 
Example 4: Pack and unpack a message in Go
 
foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

13.2.7.1.1. JSON representation
Copy link

The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example: 

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}
 
{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]): 

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
Expand
Field NameRequiredNullableTypeDescriptionFormat

typeUrl

  

String

A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL’s path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading \".\" is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, https is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

 

value

  

byte[]

Must be a valid serialized protocol buffer of the above specified type.

byte

13.2.7.2. RuntimeError
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

error

  

String

  

code

  

Integer

 

int32

message

  

String

  

details

  

List of ProtobufAny

  

13.2.7.3. V1ComplianceRun
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

id

  

String

  

clusterId

  

String

  

standardId

  

String

  

startTime

  

Date

 

date-time

finishTime

  

Date

 

date-time

state

  

V1ComplianceRunState

 

INVALID, READY, STARTED, WAIT_FOR_DATA, EVALUTING_CHECKS, FINISHED,

errorMessage

  

String

  

13.2.7.4. V1ComplianceRunSelection
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

clusterId

  

String

The ID of the cluster. \"*\" means \"all clusters\".

 

standardId

  

String

The ID of the compliance standard. \"*\" means \"all standards\".

 

13.2.7.5. V1ComplianceRunState
Copy link

Expand
Enum Values

INVALID

READY

STARTED

WAIT_FOR_DATA

EVALUTING_CHECKS

FINISHED

13.2.7.6. V1TriggerComplianceRunsRequest
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

selection

  

V1ComplianceRunSelection

  

13.2.7.7. V1TriggerComplianceRunsResponse
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

startedRuns

  

List of V1ComplianceRun

  

13.3. GetRunStatuses
Copy link

GET /v1/compliancemanagement/runstatuses

13.3.1. Description
Copy link

13.3.2. Parameters
Copy link

13.3.2.1. Query Parameters
Copy link

Expand
NameDescriptionRequiredDefaultPattern

runIds

String

-

null

 

latest

 

-

null

 

13.3.3. Return Type
Copy link

V1GetComplianceRunStatusesResponse

13.3.4. Content Type
Copy link

  • application/json

13.3.5. Responses
Copy link

Expand
Table 13.3. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

V1GetComplianceRunStatusesResponse

0

An unexpected error response.

RuntimeError

13.3.6. Samples
Copy link

13.3.7. Common object reference
Copy link

13.3.7.1. ProtobufAny
Copy link

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++. 

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

Example 2: Pack and unpack a message in Java. 

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}
 
Example 3: Pack and unpack a message in Python.
 
foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...
 
Example 4: Pack and unpack a message in Go
 
foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

13.3.7.1.1. JSON representation
Copy link

The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example: 

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}
 
{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]): 

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
Expand
Field NameRequiredNullableTypeDescriptionFormat

typeUrl

  

String

A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL’s path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading \".\" is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, https is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

 

value

  

byte[]

Must be a valid serialized protocol buffer of the above specified type.

byte

13.3.7.2. RuntimeError
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

error

  

String

  

code

  

Integer

 

int32

message

  

String

  

details

  

List of ProtobufAny

  

13.3.7.3. V1ComplianceRun
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

id

  

String

  

clusterId

  

String

  

standardId

  

String

  

startTime

  

Date

 

date-time

finishTime

  

Date

 

date-time

state

  

V1ComplianceRunState

 

INVALID, READY, STARTED, WAIT_FOR_DATA, EVALUTING_CHECKS, FINISHED,

errorMessage

  

String

  

13.3.7.4. V1ComplianceRunState
Copy link

Expand
Enum Values

INVALID

READY

STARTED

WAIT_FOR_DATA

EVALUTING_CHECKS

FINISHED

13.3.7.5. V1GetComplianceRunStatusesResponse
Copy link

Expand
Field NameRequiredNullableTypeDescriptionFormat

invalidRunIds

  

List of string

  

runs

  

List of V1ComplianceRun

  
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

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Legal Notice

Theme

© 2026 Red HatBack to top