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

    Interface TagsRequestBuilder

    Builds and executes requests for operations under /v2/tags

    interface TagsRequestBuilder {
        byTag_id(tag_id: string): WithTag_ItemRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<
                TagsRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | TagsGetResponse>;
        post(
            body: Tags,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | TagsPostResponse>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                TagsRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        toPostRequestInformation(
            body: Tags,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): TagsRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    byTag_id get post toGetRequestInformation toPostRequestInformation withUrl

    Methods

    • To list all of your tags, you can send a GET request to /v2/tags.This endpoint will only return tagged resources that you are authorized to see(e.g. Droplets will only be returned if you have droplet:read).

      Parameters

      Returns Promise<undefined | TagsGetResponse>

      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: Tags,
          requestConfiguration?: RequestConfiguration<object>,
      ): Promise<undefined | TagsPostResponse>

      To create a tag you can send a POST request to /v2/tags with a name attribute.

      Parameters

      • body: Tags

        A tag is a label that can be applied to a resource (currently Droplets, Images, Volumes, Volume Snapshots, and Database clusters) in order to better organize or facilitate the lookups and actions on it.Tags have two attributes: a user defined name attribute and an embedded resources attribute with information about resources that have been tagged.

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | TagsPostResponse>

      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 list all of your tags, you can send a GET request to /v2/tags.This endpoint will only return tagged resources that you are authorized to see(e.g. Droplets will only be returned if you have droplet:read).

      Parameters

      Returns RequestInformation

    • To create a tag you can send a POST request to /v2/tags with a name attribute.

      Parameters

      • body: Tags

        A tag is a label that can be applied to a resource (currently Droplets, Images, Volumes, Volume Snapshots, and Database clusters) in order to better organize or facilitate the lookups and actions on it.Tags have two attributes: a user defined name attribute and an embedded resources attribute with information about resources that have been tagged.

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns TagsRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods