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

    Interface WithAccess_keyItemRequestBuilder

    Builds and executes requests for operations under /v2/spaces/keys/{access_key}

    interface WithAccess_keyItemRequestBuilder {
        delete(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<void>;
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithAccess_keyGetResponse>;
        patch(
            body: Key,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithAccess_keyPatchResponse>;
        put(
            body: Key,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithAccess_keyPutResponse>;
        toDeleteRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPatchRequestInformation(
            body: Key,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPutRequestInformation(
            body: Key,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): WithAccess_keyItemRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    delete get patch put toDeleteRequestInformation toGetRequestInformation toPatchRequestInformation toPutRequestInformation withUrl

    Methods

    • To delete a Spaces Access Key, send a DELETE request to /v2/spaces/keys/$ACCESS_KEY.A successful request will return a 204 No Content status code.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns Promise<void>

      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

    • To get a Spaces Access Key, send a GET request to /v2/spaces/keys/$ACCESS_KEY.A successful request will return the Access Key.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns Promise<undefined | WithAccess_keyGetResponse>

      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

    • To update Spaces Access Key, send a PUT or PATCH request to /v2/spaces/keys/$ACCESS_KEY. At the moment, you cannot convert afullaccess key to a scoped key or vice versa. You can only update the name of the key.

      Parameters

      • body: Key

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns Promise<undefined | WithAccess_keyPatchResponse>

      error when the service returns a 400 status code

      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

    • To update Spaces Access Key, send a PUT or PATCH request to /v2/spaces/keys/$ACCESS_KEY. At the moment, you cannot convert afullaccess key to a scoped key or vice versa. You can only update the name of the key.

      Parameters

      • body: Key

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns Promise<undefined | WithAccess_keyPutResponse>

      error when the service returns a 400 status code

      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

    • To delete a Spaces Access Key, send a DELETE request to /v2/spaces/keys/$ACCESS_KEY.A successful request will return a 204 No Content status code.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns RequestInformation

    • To get a Spaces Access Key, send a GET request to /v2/spaces/keys/$ACCESS_KEY.A successful request will return the Access Key.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns RequestInformation

    • To update Spaces Access Key, send a PUT or PATCH request to /v2/spaces/keys/$ACCESS_KEY. At the moment, you cannot convert afullaccess key to a scoped key or vice versa. You can only update the name of the key.

      Parameters

      • body: Key

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns RequestInformation

    • To update Spaces Access Key, send a PUT or PATCH request to /v2/spaces/keys/$ACCESS_KEY. At the moment, you cannot convert afullaccess key to a scoped key or vice versa. You can only update the name of the key.

      Parameters

      • body: Key

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns RequestInformation

    Settings

    Member Visibility

    On This Page

    Methods