> ## Documentation Index
> Fetch the complete documentation index at: https://altostrat.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Update a tag on a resource

> Updates the value of a tag on a specific resource. This is effectively the same as creating a new tag value, as it will overwrite any existing value for that tag on the resource.



## OpenAPI

````yaml /api/en/metadata.yaml put /tags/{tagId}/values/{correlationId}
openapi: 3.0.3
info:
  title: Altostrat Metadata API
  version: 1.0.0
  description: >-
    The Altostrat Metadata API is the microservice responsible for managing
    user-defined metadata, structured tags, and associated site files for
    resources within the platform.


    It acts as a central repository for enrichment data, allowing users to
    categorize, search, and organize their network assets like sites and
    devices. This structured data is crucial for powering advanced network
    automation, reporting, and agentic AI features in the Altostrat SDX
    platform.


    This API allows you to programmatically manage:

    - **Metadata:** Arbitrary key-value pairs attached to any resource, perfect
    for storing custom information like circuit IDs or contact details.

    - **Tags:** A structured system for creating reusable labels (e.g.,
    "Region," "Customer Tier") and applying them consistently across resources.

    - **Site Files:** Attachments like network diagrams, photos, and notes
    associated with a specific site.


    Developers use this API to enrich their network resources with contextual
    data, enabling powerful filtering, automation, and organizational
    capabilities.
servers:
  - url: https://v1.api.altostrat.io
security:
  - BearerAuth: []
tags:
  - name: Tags
    description: Manage tag definitions, which act as templates for classifying resources.
  - name: Tag Values
    description: Apply, update, and remove tags on specific resources.
  - name: Metadata
    description: Manage arbitrary key-value metadata for any resource.
  - name: Site Files
    description: Manage files, such as notes, documents, and media, associated with sites.
paths:
  /tags/{tagId}/values/{correlationId}:
    put:
      tags:
        - Tag Values
      summary: Update a tag on a resource
      description: >-
        Updates the value of a tag on a specific resource. This is effectively
        the same as creating a new tag value, as it will overwrite any existing
        value for that tag on the resource.
      operationId: updateTagOnResource
      parameters:
        - $ref: '#/components/parameters/TagId'
        - $ref: '#/components/parameters/CorrelationId'
      requestBody:
        required: true
        description: The updated details for the tag value.
        content:
          application/json:
            schema:
              type: object
              required:
                - correlation_type
                - value
              properties:
                correlation_type:
                  $ref: '#/components/schemas/CorrelationType'
                value:
                  type: string
                  description: The new value for the tag on this resource.
                  example: Decommissioned
      responses:
        '200':
          description: The tag value was updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagValue'
        '400':
          description: Bad Request - The request was malformed or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  parameters:
    TagId:
      name: tagId
      in: path
      required: true
      description: The unique identifier for the tag definition.
      schema:
        type: string
      example: tag_01E8Z4Q6J7B6A5P4E3D2C1B0A9
    CorrelationId:
      name: correlationId
      in: path
      required: true
      description: The unique identifier of the resource being tagged or referenced.
      schema:
        type: string
      example: site_9b52d930f4324c0abac04c12dff85544
  schemas:
    CorrelationType:
      type: string
      description: The type of resource being correlated.
      enum:
        - site
        - user
        - wan
        - account
      example: site
    TagValue:
      type: object
      properties:
        tag_id:
          type: string
          description: The ID of the parent tag definition.
          example: tag_01E8Z4Q6J7B6A5P4E3D2C1B0A9
        correlation_id:
          type: string
          description: The ID of the resource this tag value is applied to.
          example: site_9b52d930f4324c0abac04c12dff85544
        correlation_type:
          $ref: '#/components/schemas/CorrelationType'
        value:
          type: string
          description: >-
            The specific value of the tag for this resource (e.g., "APAC",
            "High").
          example: APAC
        created_at:
          type: string
          format: date-time
          description: The timestamp when the tag value was created.
          example: '2025-10-29T13:00:00Z'
        updated_at:
          type: string
          format: date-time
          description: The timestamp when the tag value was last updated.
          example: '2025-10-29T13:00:00Z'
    ErrorResponse:
      type: object
      properties:
        type:
          type: string
          description: A broad category for the error (e.g., 'invalid_request_error').
          example: invalid_request_error
        code:
          type: string
          description: A short, unique string identifying the specific error.
          example: parameter_missing
        message:
          type: string
          description: A human-readable description of what went wrong.
          example: The 'name' parameter is required for this request.
        doc_url:
          type: string
          description: >-
            A direct link to the documentation page for this specific error
            code.
          example: https://docs.altostrat.io/errors/parameter_missing
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: A bearer token is required for all API requests.

````