list streaming endpoints.md

List Streaming Endpoints

Media API · Streaming Endpoints

GET https://app.mk.io/api/v1/projects/{project_name}/media/streamingEndpoints

Listing, Sorting and Filtering Streaming Endpoints

This endpoint returns the list of streaming endpoints in the specified project.

Sorting

The results from this endpoint can be ordered using the $orderby query parameter. Specify a list of field names, separated by commas where each one can optionally specify asc or desc.

Sorting is valid on the following fields: created, createdBy, id, name, properties/created, properties/description, properties/lastModified, properties/resourceState, properties/scaleUnits, updated, updatedBy

Filtering

The $filter query parameter allows for streaming endpoints to be filtered on the basis of fields in the schema using OData query syntax. See this document for more details on the syntax used.

Filters are valid on the following fields: created, createdBy, createdByEmail, createdByName, id, name, properties/created, properties/description, properties/lastModified, properties/resourceState, properties/scaleUnits, updated, updatedBy, updatedByEmail, updatedByName

Examples:

?$top=10 - Returns only the first 10 streaming endpoints from the list.

?$orderby=name desc - Sorts streaming endpoints by name in descending order.

?$filter=name eq 'descriptive name' - Returns streaming endpoints that match the provided name.

?$orderby=created desc - Sorts streaming endpoints by creation date in descending order.

?$filter=created ge 2021-01-01T00:00:00Z - Returns streaming endpoints created after January 1, 2021.

?$filter=properties/resourceState eq 'Running' - Returns streaming endpoints in the Running state.

RBAC Capability Required: ams.streamingendpoint.get

Authentication

Path parameters

Name Type Required Description
project_name string Yes —

Query parameters

Name Type Required Description
$orderby string No Specifies the key by which the result collection should be ordered.
$filter string No Restricts the set of items returned.
$top string No Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n.
$skiptoken string No Specifies a start offset to support paginated results. Use @odata.nextLink in the result object to enumerate the collection - it will be present only if there's more than one page of entities.

Example request

curl -X GET "https://app.mk.io/api/v1/projects/{project_name}/media/streamingEndpoints" \  
  -H "Authorization: Bearer <token>"

Responses

200 — A list of Streaming Endpoints.

Example:

{
  "@odata.nextLink": "string",
  "supplemental": {
    "count": 0,
    "kind": "string",
    "operation": "string",
    "pagination": {
      "end": 0,
      "records": 0,
      "start": 0,
      "total": 0
    },
    "subscription": {
      "id": "string",
      "name": "string"
    }
  },
  "value": [
    {
      "location": "string",
      "name": "name",
      "properties": {
        "accessControl": {
          "akamai": {
            "akamaiSignatureHeaderAuthenticationKeyList": [
              {
                "base64Key": "string",
                "expiration": "string",
                "identifier": "string"
              }
            ]
          },
          "ip": {
            "allow": [
              {
                "address": "string",
                "name": "",
                "subnetPrefixLength": 32
              }
            ]
          }
        },
        "advancedSettingsName": "string",
        "cdnBasePath": "string",
        "cdnEnabled": false,
        "cdnProfile": "string",
        "cdnProvider": "StandardAkamai",
        "created": "2024-01-01T00:00:00Z",
        "crossSiteAccessPolicies": {
          "clientAccessPolicy": "string",
          "crossDomainPolicy": "string"
        },
        "customHostNames": [
          "string"
        ],
        "description": "string",
        "hostName": "string",
        "lastModified": "2024-01-01T00:00:00Z",
        "maxCacheAge": 86400,
        "maxManifestCacheAge": 60,
        "provisioningState": "InProgress",
        "publicName": "string",
        "resourceState": "Creating",
        "scaleUnits": 0,
        "shieldCache": {
          "scaleUnits": 0
        },
        "sku": {
          "capacity": 0,
          "name": "Standard"
        },
        "urlStyle": "string"
      },
      "tags": {
        "key": "string"
      }
    }
  ]
}

400 — Bad Request

Example:

{
  "error": {
    "code": "string",
    "detail": "string",
    "extraDetail": {
      "key": null
    }
  },
  "ref": "string",
  "status": 0
}

401 — Unauthorized

Example:

{
  "error": {
    "code": "string",
    "detail": "string",
    "extraDetail": {
      "key": null
    }
  },
  "ref": "string",
  "status": 0
}

403 — Forbidden

Example:

{
  "error": {
    "code": "string",
    "detail": "string",
    "extraDetail": {
      "key": null
    }
  },
  "ref": "string",
  "status": 0
}

404 — Not Found

Example:

{
  "error": {
    "code": "string",
    "detail": "string",
    "extraDetail": {
      "key": null
    }
  },
  "ref": "string",
  "status": 0
}

429 — Too Many Requests

Example:

{
  "error": {
    "code": "string",
    "detail": "string",
    "extraDetail": {
      "key": null
    }
  },
  "ref": "string",
  "status": 0
}

500 — Internal Server Error

Example:

{
  "error": {
    "code": "string",
    "detail": "string",
    "extraDetail": {
      "key": null
    }
  },
  "ref": "string",
  "status": 0
}