3Play Media: Docs

API Access

Manage API access keys

Object Representation

Unless otherwise specified, all routes return the following data structure in the data key.

Name Type Description
id Integer ID of the API Access record
name String Optional name of the API Access record
enabled Boolean API accesss key enabled or disabled
access_type String Level of access granted by the API key: Admin or Project
project_id Integer ID of the project for project-level API Accesses
created_by_type String What created this API access (User or ApiAccess)
created_by_id Integer ID of the entity that created this API Access
user_id Integer User ID associated with this API Access
api_version String API Version of this API Access

Actions

  • List API Accesses in your account

    GET https://api.3playmedia.com/v3/admin/api_accesses/

    Parameter Type Description Required Default
    id Integer or Array<Integer> Filter API Accesses by id(s) No no default
    project_id Integer or Array<Integer> Filter API Accesses by project id(s) No no default
    access_type String Filter API Accesses by access type (admin or project) No no default
  • List details for a single API Accesses (including keys)

    GET https://api.3playmedia.com/v3/admin/api_accesses/:id

    Responds with the following attributes in addition to the standard object representation:

    Name Type Description
    api_key String The key used to identify API access
    api_secret_key String The secret key used to generate authentication signatures (signed authentication mode only)
  • Create a new API access (project access only)

    POST https://api.3playmedia.com/v3/admin/api_accesses/

    NOTE: Creating an API access without a User ID is deprecated. Some apiv3 endpoints will require API accesses with User IDs to function.

    Parameter Type Description Required Default
    name String Name used to identify the API Access record (maximum 255 characters) No no default
    project_id Integer Project ID for the new API Access Yes no default
    user_id Integer User ID associated with the new API access No no default
  • Disable an API Access

    POST https://api.3playmedia.com/v3/admin/api_accesses/:id/disable

  • Enable an API Access

    POST https://api.3playmedia.com/v3/admin/api_accesses/:id/enable

  • Disable all API Accesses for a Project

    POST https://api.3playmedia.com/v3/admin/api_accesses/disable_project_accesses

    Parameter Type Description Required Default
    project_id Integer Project ID to disable all project-level accesses for Yes no default