AMampache
Shares

Create a public share URL

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.

post/songs/{song_id}/share

Request

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

Path parameters

song_idstring required

Unique identifier of the song.

Query parameters

descriptionstring
expiresinteger

days to keep active

Request body

descriptionstring
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 shareCreateSongs was added

    • info

      added optional request body

    • 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