AMampache
Shares

Create a share

Changed on

Create a public url that can be used by anyone to stream media. Takes the file id with optional description and expires parameters.

put/shares

Request

  • Base URL
    https://develop.ampache.dev/rest/8/json
  • URL
    https://develop.ampache.dev/rest/8/json/shares
  • Auth
    • HTTP bearer
    • or API key in header auth
    • or API key in query parameter auth

Query parameters

filterstring

Object id

type'album' | 'artist' | 'playlist' | 'podcast' | 'podcast_episode' | 'song' | 'video'
descriptionstring

Filled in for you if empty

expiresinteger

Days to keep active

Request body

filterstring required

Object id

type'album' | 'artist' | 'playlist' | 'podcast' | 'podcast_episode' | 'song' | 'video' required
descriptionstring

Filled in for you if empty

expiresinteger

Days to keep active

Response

Share created

idstring required
namestring required
ownerstring required
allow_streamboolean required
allow_downloadboolean required
creation_dateinteger required
lastvisit_dateinteger required
object_typestring nullable required

The kind of object referenced, as a bare string. The set is intentionally open so a new media type is not a breaking change; values seen today include song, album, artist, playlist, podcast, podcast_episode and video.

object_idstring required
expire_daysinteger required
max_counterinteger required
counterinteger required
secretstring nullable required
public_urlstring nullable required
descriptionstring nullable required

Changes

  • e8e6b266ea29Revision changes
    • info

      api operation id shareCreate was added

    • info

      added optional request body

    • info

      the query request parameter filter became optional

    • info

      the query request parameter type became optional

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 2ff18e50dcc1Revision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status