@digitalocean/dots - v1.0.1
    Preparing search index...

    Interface CredentialsRequestBuilder

    Builds and executes requests for operations under /v2/kubernetes/clusters/{cluster_id}/credentials

    interface CredentialsRequestBuilder {
        get(
            requestConfiguration?: RequestConfiguration<
                CredentialsRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | Credentials>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                CredentialsRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        withUrl(rawUrl: string): CredentialsRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    get toGetRequestInformation withUrl

    Methods

    • This endpoint returns a JSON object . It can be used to programmaticallyconstruct Kubernetes clients which cannot parse kubeconfig files.The resulting JSON object contains token-based authentication for clusterssupporting it, and certificate-based authentication otherwise. For a list ofsupported versions and more information, see "How to Connect to a DigitalOceanKubernetes Cluster".To retrieve credentials for accessing a Kubernetes cluster, send a GETrequest to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/credentials.Clusters supporting token-based authentication may define an expiration bypassing a duration in seconds as a query parameter to/v2/kubernetes/clusters/$K8S_CLUSTER_ID/credentials?expiry_seconds=$DURATION_IN_SECONDS.If not set or 0, then the token will have a 7 day expiry. The query parameterhas no impact in certificate-based authentication.

      Parameters

      Returns Promise<undefined | Credentials>

      error when the service returns a 401 status code

      error when the service returns a 404 status code

      error when the service returns a 429 status code

      error when the service returns a 500 status code

      error when the service returns a 4XX or 5XX status code

    • This endpoint returns a JSON object . It can be used to programmaticallyconstruct Kubernetes clients which cannot parse kubeconfig files.The resulting JSON object contains token-based authentication for clusterssupporting it, and certificate-based authentication otherwise. For a list ofsupported versions and more information, see "How to Connect to a DigitalOceanKubernetes Cluster".To retrieve credentials for accessing a Kubernetes cluster, send a GETrequest to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/credentials.Clusters supporting token-based authentication may define an expiration bypassing a duration in seconds as a query parameter to/v2/kubernetes/clusters/$K8S_CLUSTER_ID/credentials?expiry_seconds=$DURATION_IN_SECONDS.If not set or 0, then the token will have a 7 day expiry. The query parameterhas no impact in certificate-based authentication.

      Parameters

      Returns RequestInformation

    Settings

    Member Visibility

    On This Page

    Methods