schema

Update an alias

Update an existing alias to point to a different collection (class). This allows you to redirect an alias from one collection to another without changing the alias name.

put/aliases/{aliasName}

Request

  • Base URL: https://localhost:8080/v1
  • URL: https://localhost:8080/v1/aliases/{aliasName}
  • Auth: one of:
    • none
    • OAuth 2 (implicit, authorization URL http://to-be-configured-in-the-application-config)

Path parameters

aliasNamestring required

Request body

classstring

The new collection (class) that the alias should point to.

Response

Successfully updated the alias to point to the new collection (class).

aliasstring

The unique name of the alias that serves as an alternative identifier for the collection.

classstring

The name of the collection (class) to which this alias is mapped.

Changes

No recorded changes to this operation across all 1 revision of this API.