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

    Interface KeysRequestBuilder

    Builds and executes requests for operations under /v2/spaces/keys

    interface KeysRequestBuilder {
        byAccess_key(access_key: string): WithAccess_keyItemRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<
                KeysRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | KeysGetResponse>;
        post(
            body: Key,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | KeysPostResponse>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                KeysRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        toPostRequestInformation(
            body: Key,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): KeysRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    byAccess_key get post toGetRequestInformation toPostRequestInformation withUrl

    Methods

    • To list Spaces Access Key, send a GET request to /v2/spaces/keys. Sort parameter must be used with Sort Direction.

      Parameters

      Returns Promise<undefined | KeysGetResponse>

      error when the service returns a 401 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

    post

    • post(
          body: Key,
          requestConfiguration?: RequestConfiguration<object>,
      ): Promise<undefined | KeysPostResponse>

      To create a new Spaces Access Key, send a POST request to /v2/spaces/keys.At the moment, you cannot mix a fullaccess permission with scoped permissions.A fullaccess permission will be prioritized if fullaccess and scoped permissions are both added.

      Parameters

      • body: Key

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | KeysPostResponse>

      error when the service returns a 400 status code

      error when the service returns a 401 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 create a new Spaces Access Key, send a POST request to /v2/spaces/keys.At the moment, you cannot mix a fullaccess permission with scoped permissions.A fullaccess permission will be prioritized if fullaccess and scoped permissions are both added.

      Parameters

      • body: Key

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns KeysRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods