This is a cache of https://docs.openshift.com/container-platform/4.5/rest_api/console_apis/consolelink-console-openshift-io-v1.html. It is a snapshot of the page at 2024-11-30T00:28:33.769+0000.
ConsoleLink [console.openshift.io/v1] - Console <strong>api</strong>s | <strong>api</strong> reference | OpenShift Container Platform 4.5
    OpenShift docs are moving and will soon only be available at docs.redhat.com, the home of all Red Hat product documentation. Explore the new docs experience today.
  1. Documentation
    2. history
×

ConsoleLink [console.openshift.io/v1]

Description

ConsoleLink is an extension for customizing OpenShift web console links.

Type

object

Required

  • spec

Specification

Property Type Description

.apiVersion

string

apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

.kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

.metadata

ObjectMeta meta/v1

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

.spec

object

ConsoleLinkSpec is the desired console link configuration.
.spec
Description

ConsoleLinkSpec is the desired console link configuration.

Type

object

Required

  • href

  • location

  • text

Property Type Description

applicationMenu

object

applicationMenu holds information about section and icon used for the link in the application menu, and it is applicable only when location is set to ApplicationMenu.

href

string

href is the absolute secure URL for the link (must use https)

location

string

location determines which location in the console the link will be appended to (ApplicationMenu, HelpMenu, UserMenu, NamespaceDashboard).

namespaceDashboard

object

namespaceDashboard holds information about namespaces in which the dashboard link should appear, and it is applicable only when location is set to NamespaceDashboard. If not specified, the link will appear in all namespaces.

text

string

text is the display text for the link
.spec.applicationMenu
Description

applicationMenu holds information about section and icon used for the link in the application menu, and it is applicable only when location is set to ApplicationMenu.

Type

object

Required

  • section

Property Type Description

imageURL

string

imageUrl is the URL for the icon used in front of the link in the application menu. The URL must be an HTTPS URL or a Data URI. The image should be square and will be shown at 24x24 pixels.

section

string

section is the section of the application menu in which the link should appear. This can be any text that will appear as a subheading in the application menu dropdown. A new section will be created if the text does not match text of an existing section.
.spec.namespaceDashboard
Description

namespaceDashboard holds information about namespaces in which the dashboard link should appear, and it is applicable only when location is set to NamespaceDashboard. If not specified, the link will appear in all namespaces.

Type

object

Property Type Description

namespaceSelector

object

namespaceSelector is used to select the Namespaces that should contain dashboard link by label. If the namespace labels match, dashboard link will be shown for the namespaces.

namespaces

array (string)

namespaces is an array of namespace names in which the dashboard link should appear.
.spec.namespaceDashboard.namespaceSelector
Description

namespaceSelector is used to select the Namespaces that should contain dashboard link by label. If the namespace labels match, dashboard link will be shown for the namespaces.

Type

object

Property Type Description

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
.spec.namespaceDashboard.namespaceSelector.matchExpressions
Description

matchExpressions is a list of label selector requirements. The requirements are ANDed.

Type

array

.spec.namespaceDashboard.namespaceSelector.matchExpressions[]
Description

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Type

object

Required

  • key

  • operator

Property Type Description

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

api endpoints

The following api endpoints are available:

  • /apis/console.openshift.io/v1/consolelinks

    • DELETE: delete collection of ConsoleLink

    • GET: list objects of kind ConsoleLink

    • POST: create a ConsoleLink

  • /apis/console.openshift.io/v1/consolelinks/{name}

    • DELETE: delete a ConsoleLink

    • GET: read the specified ConsoleLink

    • PATCH: partially update the specified ConsoleLink

    • PUT: replace the specified ConsoleLink

  • /apis/console.openshift.io/v1/consolelinks/{name}/status

    • GET: read status of the specified ConsoleLink

    • PATCH: partially update status of the specified ConsoleLink

    • PUT: replace status of the specified ConsoleLink

Table 1. Global guery parameters
Parameter Type Description

pretty

string

If 'true', then the output is pretty printed.
HTTP method

DELETE

Description

delete collection of ConsoleLink

Table 2. Query parameters
Parameter Type Description

allowWatchBookmarks

boolean

allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.

continue

string

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key".

This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector

string

A selector to restrict the list of returned objects by their fields. Defaults to everything.

labelSelector

string

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit

integer

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

resourceVersion

string

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

timeoutSeconds

integer

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch

boolean

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
Table 3. HTTP responses
HTTP code Reponse body

200 - OK

Status meta/v1

401 - Unauthorized

Empty
HTTP method

GET

Description

list objects of kind ConsoleLink

Table 4. Query parameters
Parameter Type Description

allowWatchBookmarks

boolean

allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.

continue

string

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key".

This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector

string

A selector to restrict the list of returned objects by their fields. Defaults to everything.

labelSelector

string

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit

integer

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

resourceVersion

string

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

timeoutSeconds

integer

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch

boolean

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
Table 5. HTTP responses
HTTP code Reponse body

200 - OK

ConsoleLinkList console.openshift.io/v1

401 - Unauthorized

Empty
HTTP method

POST

Description

create a ConsoleLink

Table 6. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldManager

string

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
Table 7. Body parameters
Parameter Type Description

body

ConsoleLink console.openshift.io/v1
Table 8. HTTP responses
HTTP code Reponse body

200 - OK

ConsoleLink console.openshift.io/v1

201 - Created

ConsoleLink console.openshift.io/v1

202 - Accepted

ConsoleLink console.openshift.io/v1

401 - Unauthorized

Empty

/apis/console.openshift.io/v1/consolelinks/{name}

Table 9. Global path parameters
Parameter Type Description

name

string

name of the ConsoleLink
Table 10. Global guery parameters
Parameter Type Description

pretty

string

If 'true', then the output is pretty printed.
HTTP method

DELETE

Description

delete a ConsoleLink

Table 11. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

gracePeriodSeconds

integer

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

orphanDependents

boolean

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.

propagationPolicy

string

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
Table 12. Body parameters
Parameter Type Description

body

DeleteOptions meta/v1
Table 13. HTTP responses
HTTP code Reponse body

200 - OK

Status meta/v1

202 - Accepted

Status meta/v1

401 - Unauthorized

Empty
HTTP method

GET

Description

read the specified ConsoleLink

Table 14. Query parameters
Parameter Type Description

resourceVersion

string

When specified: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
Table 15. HTTP responses
HTTP code Reponse body

200 - OK

ConsoleLink console.openshift.io/v1

401 - Unauthorized

Empty
HTTP method

PATCH

Description

partially update the specified ConsoleLink

Table 16. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldManager

string

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
Table 17. Body parameters
Parameter Type Description

body

Patch meta/v1
Table 18. HTTP responses
HTTP code Reponse body

200 - OK

ConsoleLink console.openshift.io/v1

401 - Unauthorized

Empty
HTTP method

PUT

Description

replace the specified ConsoleLink

Table 19. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldManager

string

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
Table 20. Body parameters
Parameter Type Description

body

ConsoleLink console.openshift.io/v1
Table 21. HTTP responses
HTTP code Reponse body

200 - OK

ConsoleLink console.openshift.io/v1

201 - Created

ConsoleLink console.openshift.io/v1

401 - Unauthorized

Empty

/apis/console.openshift.io/v1/consolelinks/{name}/status

Table 22. Global path parameters
Parameter Type Description

name

string

name of the ConsoleLink
Table 23. Global guery parameters
Parameter Type Description

pretty

string

If 'true', then the output is pretty printed.
HTTP method

GET

Description

read status of the specified ConsoleLink

Table 24. Query parameters
Parameter Type Description

resourceVersion

string

When specified: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
Table 25. HTTP responses
HTTP code Reponse body

200 - OK

ConsoleLink console.openshift.io/v1

401 - Unauthorized

Empty
HTTP method

PATCH

Description

partially update status of the specified ConsoleLink

Table 26. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldManager

string

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
Table 27. Body parameters
Parameter Type Description

body

Patch meta/v1
Table 28. HTTP responses
HTTP code Reponse body

200 - OK

ConsoleLink console.openshift.io/v1

401 - Unauthorized

Empty
HTTP method

PUT

Description

replace status of the specified ConsoleLink

Table 29. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldManager

string

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
Table 30. Body parameters
Parameter Type Description

body

ConsoleLink console.openshift.io/v1
Table 31. HTTP responses
HTTP code Reponse body

200 - OK

ConsoleLink console.openshift.io/v1

201 - Created

ConsoleLink console.openshift.io/v1

401 - Unauthorized

Empty