Namespace [core/v1]

    Namespace provides a scope for Names. Use of multiple namespaces is optional.

    Type

    .spec

    Description

    NamespaceSpec describes the attributes on a Namespace.

    Type

    object

    PropertyTypeDescription

    finalizers

    array (string)

    Finalizers is an opaque list of values that must be empty to permanently remove object from storage. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/

    .status

    Description

    NamespaceStatus is information about the current status of a Namespace.

    Type

    object

    PropertyTypeDescription

    conditions

    Represents the latest available observations of a namespace’s current state.

    phase

    string

    Phase is the current lifecycle phase of the namespace. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/

    API endpoints

    The following API endpoints are available:

    • /api/v1/namespaces/{name}

      • DELETE: delete a Namespace

      • GET: read the specified Namespace

      • PATCH: partially update the specified Namespace

    • /api/v1/namespaces/{name}/status

      • GET: read status of the specified Namespace

      • PATCH: partially update status of the specified Namespace

      • PUT: replace status of the specified Namespace

    • /api/v1/namespaces/{name}/finalize

      • PUT: replace finalize of the specified Namespace
    Table 1. Global guery parameters
    ParameterTypeDescription

    pretty

    string

    If ‘true’, then the output is pretty printed.

    HTTP method

    GET

    Description

    list or watch objects of kind Namespace

    Table 2. Query parameters
    ParameterTypeDescription

    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

    resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

    Defaults to unset

    resourceVersionMatch

    string

    resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See for details.

    Defaults to unset

    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 codeReponse body

    NamespaceList core/v1

    401 - Unauthorized

    Empty

    HTTP method

    POST

    Description

    create a Namespace

    Table 4. Query parameters
    ParameterTypeDescription

    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 .

    Table 5. Body parameters
    ParameterTypeDescription

    body

    Namespace core/v1

    Table 6. HTTP responses
    HTTP codeReponse body

    200 - OK

    201 - Created

    Namespace core/v1

    202 - Accepted

    401 - Unauthorized

    Empty

    Table 7. Global path parameters
    ParameterTypeDescription

    name

    string

    name of the Namespace

    Table 8. Global guery parameters
    ParameterTypeDescription

    pretty

    string

    If ‘true’, then the output is pretty printed.

    HTTP method

    DELETE

    Description

    delete a Namespace

    Table 10. Body parameters
    ParameterTypeDescription

    body

    DeleteOptions meta/v1

    Table 11. HTTP responses
    HTTP codeReponse body

    200 - OK

    202 - Accepted

    Status meta/v1

    401 - Unauthorized

    Empty

    HTTP method

    GET

    Description

    read the specified Namespace

    Table 12. Query parameters
    ParameterTypeDescription

    exact

    boolean

    Should the export be exact. Exact export maintains cluster-specific fields like ‘Namespace’. Deprecated. Planned for removal in 1.18.

    export

    boolean

    Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18.

    Table 13. HTTP responses
    HTTP codeReponse body

    200 - OK

    401 - Unauthorized

    Empty

    HTTP method

    PATCH

    Description

    partially update the specified Namespace

    Table 14. Query parameters
    ParameterTypeDescription

    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. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

    force

    boolean

    Force is going to “force” Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

    Table 15. Body parameters
    ParameterTypeDescription

    Table 16. HTTP responses
    HTTP codeReponse body

    200 - OK

    Namespace core/v1

    401 - Unauthorized

    Empty

    HTTP method

    PUT

    Description

    Table 17. Query parameters
    ParameterTypeDescription

    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 .

    Table 18. Body parameters
    ParameterTypeDescription

    body

    Namespace core/v1

    Table 19. HTTP responses
    HTTP codeReponse body

    200 - OK

    201 - Created

    Namespace core/v1

    401 - Unauthorized

    Empty

    Table 21. Global guery parameters
    ParameterTypeDescription

    pretty

    string

    If ‘true’, then the output is pretty printed.

    HTTP method

    GET

    Description

    read status of the specified Namespace

    Table 22. HTTP responses
    HTTP codeReponse body

    200 - OK

    401 - Unauthorized

    Empty

    HTTP method

    PATCH

    Description

    partially update status of the specified Namespace

    Table 23. Query parameters
    ParameterTypeDescription

    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. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

    force

    boolean

    Force is going to “force” Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

    Table 24. Body parameters
    ParameterTypeDescription

    body

    Table 25. HTTP responses
    HTTP codeReponse body

    200 - OK

    Namespace core/v1

    401 - Unauthorized

    Empty

    HTTP method

    PUT

    Description

    replace status of the specified Namespace

    Table 26. Query parameters
    ParameterTypeDescription

    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 .

    Table 27. Body parameters
    ParameterTypeDescription

    body

    Namespace core/v1

    Table 28. HTTP responses
    HTTP codeReponse body

    200 - OK

    201 - Created

    Namespace core/v1

    401 - Unauthorized

    Empty

    Table 29. Global path parameters
    ParameterTypeDescription

    name

    string

    name of the Namespace

    Table 30. Global guery parameters
    ParameterTypeDescription

    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 .

    pretty

    string

    If ‘true’, then the output is pretty printed.

    HTTP method

    PUT

    Description

    replace finalize of the specified Namespace

    Table 32. HTTP responses
    HTTP codeReponse body

    200 - OK

    201 - Created

    401 - Unauthorized

    Empty