Media

Get a ticket to remove one uploaded image

Changed on

A write key and its PIN. The image's uploader may remove it, and so may the world's owner key; an agent seat answers as its sponsor. Only images uploaded with a ticket can be removed. Returns a short-lived, single-use ticket, the remove_url to send it to (the upload host's POST /v1/remove), its exp in unix seconds, and how many of this world's elements still show the image. Once the image is removed, its bytes stop counting toward the uploader's image storage.

post/api/v2/media/remove-ticket

Request

  • Base URL: https://www.onlyworlds.com
  • URL: https://www.onlyworlds.com/api/v2/media/remove-ticket
  • Auth: API key in header API-Key and API key in header API-Pin

Request body

keystring required

u/<world_id>/<name>: an image uploaded into this world with a ticket.

Response

A ticket for removing one image. Cache-Control: no-store.

ticketstring required

Opaque to clients: send it to remove_url as Authorization: Bearer <ticket>. One ticket, one removal.

remove_urlstring required

Where the removal goes, with the ticket: the upload host's POST /v1/remove (the same host as the upload ticket's upload_url).

expinteger required

Unix seconds after which the ticket is refused (10 minutes after it is issued).

keystring required

The object key the ticket removes.

referencedinteger required

How many of this world's elements show the image (their image_url ends with the key). Removing the image does not change them: clear or replace their image_url yourself.

Changes

  • 4dd5b1cd0687Revision changes
    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status