> For the complete documentation index, see [llms.txt](https://knowledgebase.fabricdata.com/studio/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://knowledgebase.fabricdata.com/studio/integrations-and-apis/origin-studio-production-api/licensed-metadata.md).

# Licensed Metadata

Enable or disable a licensed metadata provider, such as Gracenote, for your tenant with your own API key. Your tenant's licensed data stays separate from other tenants'.

## List a tenant's licensed metadata provider configs

> Lists your tenant's licensed metadata provider configs. A provider without a config is off.

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"tags":[{"name":"Licensed Metadata","description":"Enable or disable a licensed metadata provider, such as Gracenote, for your tenant with your own API key. Your tenant's licensed data stays separate from other tenants'."}],"servers":[{"url":"{protocol}://{domain}/{basePath}","variables":{"protocol":{"enum":["http","https"],"default":"https"},"domain":{"default":"api.studio.fabricdata.com"},"basePath":{"default":"v1"}}}],"security":[{"jwt-apikey-authorizer":[]}],"components":{"securitySchemes":{"jwt-apikey-authorizer":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"LicensedMetadataConfigFindManyResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ILicensedMetadataConfigFindManyResponse","description":"The tenant's licensed metadata provider configs.","additionalProperties":false,"required":["data","links","jsonapi"],"type":"object","properties":{"data":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/BaseResource"},{"type":"object","properties":{"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/LicensedMetadataConfigAttributes"}]},"meta":{"type":"object","description":"`seedJobId`: the seed job. Check it with `GET /backgroundJobs/{jobId}`.","properties":{"seedJobId":{"type":"string","description":"The background job that ran, or is running, the initial seed. Present once a seed has started."}},"additionalProperties":false}},"required":["attributes"],"additionalProperties":false}]}},"links":{"type":"object","required":["self"],"properties":{"self":{"type":"string"}},"additionalProperties":false},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"BaseResource":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBaseResource","description":"A resource identifier. Every resource object carries a unique `id` and a `type`, the resource type name such as `records` or `contributors`.","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"BaseResourceAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBaseResourceAttributes","description":"Timestamps on every resource's attributes, as ISO 8601 date-times. `created` marks the resource's creation; `updated` marks its last change.","type":"object","additionalProperties":false,"required":["created","updated"],"properties":{"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"}}},"LicensedMetadataConfigAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ILicensedMetadataConfigAttributes","description":"The tenant's licensed metadata provider config (read-only). The provider is enabled while this resource exists; delete it to disable the provider. Shows a partial preview of the API key, never the raw key.","type":"object","additionalProperties":false,"required":["provider","apiKeyConfigured","programsPollingIntervalMinutes","taxonomyPollingInterval","seedingStatus"],"properties":{"provider":{"type":"string","enum":["gracenote"],"description":"The licensed metadata provider this config enables."},"apiKeyConfigured":{"type":"boolean","description":"Whether the tenant has a stored API key for this provider."},"apiKeyPreview":{"type":"string","description":"First 2 and last 2 characters of the stored API key (e.g. \"gc••••9a\"), for display only. Absent until you store a key."},"programsPollingIntervalMinutes":{"type":"integer","enum":[15,30,45,60],"description":"How often to poll for program updates once the initial seed has caught up."},"taxonomyPollingInterval":{"type":"string","enum":["daily","weekly"],"description":"How often to check the provider's reference taxonomy for changes."},"pollingPaused":{"type":"boolean","description":"True when the tenant has paused steady-state polling. While paused:\n- both feeds stop polling, and a steady-state drain in flight stops at its next page, so polling spends no provider API quota\n- an initial seed job already running still finishes\n\nCursors, cached data and the cadence stay, so resuming continues where polling stopped without re-crawling. Absent means not paused."},"seedingStatus":{"type":"string","enum":["not_started","seeding","finished","failed"],"description":"Status of the initial data seed. Ongoing polling starts only once it reaches `finished`."},"seedingError":{"type":"string","description":"Why the initial seed failed. Present only when `seedingStatus` is `failed`."},"seedingStartedAt":{"type":"string","format":"date-time","description":"When the most recent initial seed started. Stays visible for the life of the integration, after the seed's background job expires (7 days). Absent until a seed has started."},"seedingFinishedAt":{"type":"string","format":"date-time","description":"When the most recent initial seed succeeded or failed. Absent while a seed is running, and on some older seeds."},"polling":{"type":"object","additionalProperties":false,"description":"Steady-state polling health per feed: shows whether ongoing ingestion works after the initial seed. A feed key is absent until that feed's first poll.","properties":{"programs":{"$ref":"#/components/schemas/LicensedMetadataFeedHealth"},"taxonomy":{"$ref":"#/components/schemas/LicensedMetadataFeedHealth"}}},"sandbox":{"type":"boolean","description":"True when this config uses the Fabric sandbox API key: its cached records are synthetic test data, not licensed Gracenote content. Sandbox titles carry a TMSId prefix Gracenote never issues (ZZ...), so you can spot them anywhere. Read-only, derived from the key."}}},"LicensedMetadataFeedHealth":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ILicensedMetadataFeedHealth","description":"Steady-state polling health of one licensed metadata feed. Present after the feed's first poll.","type":"object","additionalProperties":false,"required":["status"],"properties":{"status":{"type":"string","enum":["pending","ok","unauthorized","error"],"description":"Outcome of the most recent poll:\n- `pending`: scheduled, no poll completed yet\n- `ok`: succeeded\n- `unauthorized`: the provider rejected the API key; rotate it with `PATCH`\n- `error`: any other failure"},"lastPolledAt":{"type":"string","description":"ISO timestamp of the most recent poll attempt, whatever its outcome."},"lastSuccessAt":{"type":"string","description":"ISO timestamp of the most recent successful poll. If it goes stale while `status` is not `ok`, ingestion is failing."},"nextPollAt":{"type":"string","description":"Estimated ISO timestamp of the next poll: `lastPolledAt` plus the feed's interval. The schedule fires on a fixed cadence, so an interval change takes effect from the next tick."},"caughtUp":{"type":"boolean","description":"Whether the feed had no pending updates at the last successful poll."},"stalled":{"type":"boolean","description":"True when the feed is overdue: the current time is well past `nextPollAt`, so the scheduler seems to have stopped, not just gone idle. `status` and `message` keep the last known outcome and may look healthy; treat `stalled` as its own \"polling stopped\" signal. Absent while the feed polls on schedule."},"behindBy":{"type":"integer","description":"Approximate number of update-stream positions still pending at the last successful poll (0 when caught up)."},"message":{"type":"string","description":"What went wrong and what to do about it. Present for non-`ok` statuses."}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false},"ErrorResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IErrorResponse","description":"The body of a failed request: an `errors` array with one or more error objects.","type":"object","required":["errors","jsonapi"],"additionalProperties":false,"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"Error":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IError","description":"One JSON:API error object. `status` is the HTTP status code as a string, `title` a short summary and `detail` optional context. `meta` can carry structured conflict or authorization details.","type":"object","additionalProperties":false,"required":["status","title"],"properties":{"status":{"type":"string"},"title":{"type":"string"},"code":{"type":"string","description":"A stable code for the problem that you can act on, when the operation documents one."},"detail":{"type":"string"},"source":{"type":"object","description":"A JSON Pointer to the request field that caused the error, such as `/data/attributes/title`.","properties":{"pointer":{"type":"string"}}},"meta":{"type":"object","additionalProperties":true,"properties":{"stack":{"type":"string","description":"The error's stack trace. Non-production environments only."},"conflictItems":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"unauthorizedItems":{"type":"array","items":{"type":"string"}}}}}}}},"paths":{"/global/licensedMetadataConfigs":{"get":{"summary":"List a tenant's licensed metadata provider configs","operationId":"licensedMetadataConfigFindMany","description":"Lists your tenant's licensed metadata provider configs. A provider without a config is off.","tags":["Licensed Metadata"],"parameters":[{"name":"filter.provider","description":"Returns only this provider's config. Omit to list every provider.","in":"query","required":false,"schema":{"type":"string","enum":["gracenote"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicensedMetadataConfigFindManyResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## Enable a licensed metadata provider for a tenant

> Enables a licensed metadata provider, such as Gracenote, for your tenant with your own API key. A tenant can have one config per provider.

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"tags":[{"name":"Licensed Metadata","description":"Enable or disable a licensed metadata provider, such as Gracenote, for your tenant with your own API key. Your tenant's licensed data stays separate from other tenants'."}],"servers":[{"url":"{protocol}://{domain}/{basePath}","variables":{"protocol":{"enum":["http","https"],"default":"https"},"domain":{"default":"api.studio.fabricdata.com"},"basePath":{"default":"v1"}}}],"security":[{"jwt-apikey-authorizer":[]}],"components":{"securitySchemes":{"jwt-apikey-authorizer":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"CreateLicensedMetadataConfigRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreateLicensedMetadataConfigRequest","description":"Enables a licensed metadata provider for the tenant. A tenant can have one config per provider.","type":"object","additionalProperties":false,"required":["data"],"properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"object","additionalProperties":false,"required":["type","attributes"],"properties":{"type":{"type":"string","enum":["licensedMetadataConfigs"]},"attributes":{"$ref":"#/components/schemas/CreateLicensedMetadataConfigAttributes"}}}}},"WriteRequestMeta":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWriteRequestMeta","description":"Audit metadata for a write request. `audit.source` names the surface that sent it, such as `studio-web`, `studio-mcp`, `api` or `system`; `audit.reason` is a free-text justification.","type":"object","additionalProperties":false,"properties":{"audit":{"type":"object","additionalProperties":false,"properties":{"source":{"type":"string","maxLength":64},"reason":{"type":"string","maxLength":256}}}}},"CreateLicensedMetadataConfigAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ICreateLicensedMetadataConfigAttributes","description":"Enables a licensed metadata provider for the tenant. Requires the tenant's own provider API key: Fabric never shares a key across tenants.","type":"object","additionalProperties":false,"required":["provider","apiKey","programsPollingIntervalMinutes","taxonomyPollingInterval"],"properties":{"provider":{"type":"string","enum":["gracenote"],"description":"The licensed metadata provider to enable."},"apiKey":{"type":"string","description":"Write-only. The tenant's own provider API key. The server stores it as a per-tenant secret and never returns it."},"programsPollingIntervalMinutes":{"type":"integer","enum":[15,30,45,60],"description":"How often to poll for program updates once the initial seed has caught up. Each poll spends the tenant's own provider API quota. No default."},"taxonomyPollingInterval":{"type":"string","enum":["daily","weekly"],"description":"How often to check the provider's reference taxonomy for changes. The taxonomy is small and rarely changes. Each check spends the tenant's own API quota. No default."}}},"LicensedMetadataConfigCreateOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"ILicensedMetadataConfigCreateOneResponse","description":"The licensed metadata provider config you just enabled, with its self link.","additionalProperties":false,"required":["data","links","jsonapi"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/BaseResource"},{"type":"object","properties":{"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/LicensedMetadataConfigAttributes"}]},"meta":{"type":"object","description":"`seedJobId`: the seed job. Check it with `GET /backgroundJobs/{jobId}`.","properties":{"seedJobId":{"type":"string","description":"The background job that ran, or is running, the initial seed. Present once a seed has started."}},"additionalProperties":false}},"required":["attributes"],"additionalProperties":false}]},"links":{"type":"object","properties":{"self":{"type":"string"}},"required":["self"],"additionalProperties":false},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"BaseResource":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBaseResource","description":"A resource identifier. Every resource object carries a unique `id` and a `type`, the resource type name such as `records` or `contributors`.","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"BaseResourceAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBaseResourceAttributes","description":"Timestamps on every resource's attributes, as ISO 8601 date-times. `created` marks the resource's creation; `updated` marks its last change.","type":"object","additionalProperties":false,"required":["created","updated"],"properties":{"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"}}},"LicensedMetadataConfigAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ILicensedMetadataConfigAttributes","description":"The tenant's licensed metadata provider config (read-only). The provider is enabled while this resource exists; delete it to disable the provider. Shows a partial preview of the API key, never the raw key.","type":"object","additionalProperties":false,"required":["provider","apiKeyConfigured","programsPollingIntervalMinutes","taxonomyPollingInterval","seedingStatus"],"properties":{"provider":{"type":"string","enum":["gracenote"],"description":"The licensed metadata provider this config enables."},"apiKeyConfigured":{"type":"boolean","description":"Whether the tenant has a stored API key for this provider."},"apiKeyPreview":{"type":"string","description":"First 2 and last 2 characters of the stored API key (e.g. \"gc••••9a\"), for display only. Absent until you store a key."},"programsPollingIntervalMinutes":{"type":"integer","enum":[15,30,45,60],"description":"How often to poll for program updates once the initial seed has caught up."},"taxonomyPollingInterval":{"type":"string","enum":["daily","weekly"],"description":"How often to check the provider's reference taxonomy for changes."},"pollingPaused":{"type":"boolean","description":"True when the tenant has paused steady-state polling. While paused:\n- both feeds stop polling, and a steady-state drain in flight stops at its next page, so polling spends no provider API quota\n- an initial seed job already running still finishes\n\nCursors, cached data and the cadence stay, so resuming continues where polling stopped without re-crawling. Absent means not paused."},"seedingStatus":{"type":"string","enum":["not_started","seeding","finished","failed"],"description":"Status of the initial data seed. Ongoing polling starts only once it reaches `finished`."},"seedingError":{"type":"string","description":"Why the initial seed failed. Present only when `seedingStatus` is `failed`."},"seedingStartedAt":{"type":"string","format":"date-time","description":"When the most recent initial seed started. Stays visible for the life of the integration, after the seed's background job expires (7 days). Absent until a seed has started."},"seedingFinishedAt":{"type":"string","format":"date-time","description":"When the most recent initial seed succeeded or failed. Absent while a seed is running, and on some older seeds."},"polling":{"type":"object","additionalProperties":false,"description":"Steady-state polling health per feed: shows whether ongoing ingestion works after the initial seed. A feed key is absent until that feed's first poll.","properties":{"programs":{"$ref":"#/components/schemas/LicensedMetadataFeedHealth"},"taxonomy":{"$ref":"#/components/schemas/LicensedMetadataFeedHealth"}}},"sandbox":{"type":"boolean","description":"True when this config uses the Fabric sandbox API key: its cached records are synthetic test data, not licensed Gracenote content. Sandbox titles carry a TMSId prefix Gracenote never issues (ZZ...), so you can spot them anywhere. Read-only, derived from the key."}}},"LicensedMetadataFeedHealth":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ILicensedMetadataFeedHealth","description":"Steady-state polling health of one licensed metadata feed. Present after the feed's first poll.","type":"object","additionalProperties":false,"required":["status"],"properties":{"status":{"type":"string","enum":["pending","ok","unauthorized","error"],"description":"Outcome of the most recent poll:\n- `pending`: scheduled, no poll completed yet\n- `ok`: succeeded\n- `unauthorized`: the provider rejected the API key; rotate it with `PATCH`\n- `error`: any other failure"},"lastPolledAt":{"type":"string","description":"ISO timestamp of the most recent poll attempt, whatever its outcome."},"lastSuccessAt":{"type":"string","description":"ISO timestamp of the most recent successful poll. If it goes stale while `status` is not `ok`, ingestion is failing."},"nextPollAt":{"type":"string","description":"Estimated ISO timestamp of the next poll: `lastPolledAt` plus the feed's interval. The schedule fires on a fixed cadence, so an interval change takes effect from the next tick."},"caughtUp":{"type":"boolean","description":"Whether the feed had no pending updates at the last successful poll."},"stalled":{"type":"boolean","description":"True when the feed is overdue: the current time is well past `nextPollAt`, so the scheduler seems to have stopped, not just gone idle. `status` and `message` keep the last known outcome and may look healthy; treat `stalled` as its own \"polling stopped\" signal. Absent while the feed polls on schedule."},"behindBy":{"type":"integer","description":"Approximate number of update-stream positions still pending at the last successful poll (0 when caught up)."},"message":{"type":"string","description":"What went wrong and what to do about it. Present for non-`ok` statuses."}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false},"ErrorResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IErrorResponse","description":"The body of a failed request: an `errors` array with one or more error objects.","type":"object","required":["errors","jsonapi"],"additionalProperties":false,"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"Error":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IError","description":"One JSON:API error object. `status` is the HTTP status code as a string, `title` a short summary and `detail` optional context. `meta` can carry structured conflict or authorization details.","type":"object","additionalProperties":false,"required":["status","title"],"properties":{"status":{"type":"string"},"title":{"type":"string"},"code":{"type":"string","description":"A stable code for the problem that you can act on, when the operation documents one."},"detail":{"type":"string"},"source":{"type":"object","description":"A JSON Pointer to the request field that caused the error, such as `/data/attributes/title`.","properties":{"pointer":{"type":"string"}}},"meta":{"type":"object","additionalProperties":true,"properties":{"stack":{"type":"string","description":"The error's stack trace. Non-production environments only."},"conflictItems":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"unauthorizedItems":{"type":"array","items":{"type":"string"}}}}}}}},"paths":{"/global/licensedMetadataConfigs":{"post":{"summary":"Enable a licensed metadata provider for a tenant","operationId":"licensedMetadataConfigCreateOne","description":"Enables a licensed metadata provider, such as Gracenote, for your tenant with your own API key. A tenant can have one config per provider.","tags":["Licensed Metadata"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLicensedMetadataConfigRequest"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicensedMetadataConfigCreateOneResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict: your tenant already has a config for this provider","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## Disable a licensed metadata provider config

> Disables a licensed metadata provider config. Deletes the stored API key immediately and keeps the provider data already fetched.

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"tags":[{"name":"Licensed Metadata","description":"Enable or disable a licensed metadata provider, such as Gracenote, for your tenant with your own API key. Your tenant's licensed data stays separate from other tenants'."}],"servers":[{"url":"{protocol}://{domain}/{basePath}","variables":{"protocol":{"enum":["http","https"],"default":"https"},"domain":{"default":"api.studio.fabricdata.com"},"basePath":{"default":"v1"}}}],"security":[{"jwt-apikey-authorizer":[]}],"components":{"securitySchemes":{"jwt-apikey-authorizer":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ErrorResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IErrorResponse","description":"The body of a failed request: an `errors` array with one or more error objects.","type":"object","required":["errors","jsonapi"],"additionalProperties":false,"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"Error":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IError","description":"One JSON:API error object. `status` is the HTTP status code as a string, `title` a short summary and `detail` optional context. `meta` can carry structured conflict or authorization details.","type":"object","additionalProperties":false,"required":["status","title"],"properties":{"status":{"type":"string"},"title":{"type":"string"},"code":{"type":"string","description":"A stable code for the problem that you can act on, when the operation documents one."},"detail":{"type":"string"},"source":{"type":"object","description":"A JSON Pointer to the request field that caused the error, such as `/data/attributes/title`.","properties":{"pointer":{"type":"string"}}},"meta":{"type":"object","additionalProperties":true,"properties":{"stack":{"type":"string","description":"The error's stack trace. Non-production environments only."},"conflictItems":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"unauthorizedItems":{"type":"array","items":{"type":"string"}}}}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false}}},"paths":{"/global/licensedMetadataConfigs/{licensedMetadataConfigId}":{"delete":{"summary":"Disable a licensed metadata provider config","operationId":"licensedMetadataConfigDeleteOne","description":"Disables a licensed metadata provider config. Deletes the stored API key immediately and keeps the provider data already fetched.","tags":["Licensed Metadata"],"parameters":[{"name":"licensedMetadataConfigId","description":"The config to disable.","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## Update a licensed metadata provider config

> Rotates the provider API key or changes the polling cadence and keeps the data already fetched. Changes only the attributes you send. The API key is write-only.

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"tags":[{"name":"Licensed Metadata","description":"Enable or disable a licensed metadata provider, such as Gracenote, for your tenant with your own API key. Your tenant's licensed data stays separate from other tenants'."}],"servers":[{"url":"{protocol}://{domain}/{basePath}","variables":{"protocol":{"enum":["http","https"],"default":"https"},"domain":{"default":"api.studio.fabricdata.com"},"basePath":{"default":"v1"}}}],"security":[{"jwt-apikey-authorizer":[]}],"components":{"securitySchemes":{"jwt-apikey-authorizer":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"UpdateLicensedMetadataConfigRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUpdateLicensedMetadataConfigRequest","description":"Updates a licensed metadata provider config, for example to rotate the API key. The path parameter identifies the config; the body carries only the attributes to change.","type":"object","additionalProperties":false,"required":["data"],"properties":{"meta":{"$ref":"#/components/schemas/WriteRequestMeta"},"data":{"type":"object","additionalProperties":false,"required":["type","attributes"],"properties":{"type":{"type":"string","enum":["licensedMetadataConfigs"]},"attributes":{"$ref":"#/components/schemas/UpdateLicensedMetadataConfigAttributes"}}}}},"WriteRequestMeta":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IWriteRequestMeta","description":"Audit metadata for a write request. `audit.source` names the surface that sent it, such as `studio-web`, `studio-mcp`, `api` or `system`; `audit.reason` is a free-text justification.","type":"object","additionalProperties":false,"properties":{"audit":{"type":"object","additionalProperties":false,"properties":{"source":{"type":"string","maxLength":64},"reason":{"type":"string","maxLength":256}}}}},"UpdateLicensedMetadataConfigAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUpdateLicensedMetadataConfigAttributes","description":"Attributes to change on a licensed metadata provider config. Send only what you want to change. You can't change the provider.","type":"object","additionalProperties":false,"properties":{"apiKey":{"type":"string","description":"Write-only. A new provider API key to rotate to. The server stores it as a per-tenant secret, overwrites the old one and never returns it. Rotating keeps the existing cache."},"programsPollingIntervalMinutes":{"type":"integer","enum":[15,30,45,60],"description":"How often to poll for program updates once the initial seed has caught up."},"taxonomyPollingInterval":{"type":"string","enum":["daily","weekly"],"description":"How often to check the provider's reference taxonomy for changes."},"pollingPaused":{"type":"boolean","description":"`true` pauses steady-state polling, `false` resumes it. Pausing stops both feeds' schedules and stops a steady-state drain in flight at its next page; an initial seed job already running still finishes. Pausing deletes nothing: cursors, cached data and the cadence stay, and resuming continues where polling stopped. Changing the cadence while paused keeps polling paused."}}},"LicensedMetadataConfigCreateOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"ILicensedMetadataConfigCreateOneResponse","description":"The licensed metadata provider config you just enabled, with its self link.","additionalProperties":false,"required":["data","links","jsonapi"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/BaseResource"},{"type":"object","properties":{"attributes":{"allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"$ref":"#/components/schemas/LicensedMetadataConfigAttributes"}]},"meta":{"type":"object","description":"`seedJobId`: the seed job. Check it with `GET /backgroundJobs/{jobId}`.","properties":{"seedJobId":{"type":"string","description":"The background job that ran, or is running, the initial seed. Present once a seed has started."}},"additionalProperties":false}},"required":["attributes"],"additionalProperties":false}]},"links":{"type":"object","properties":{"self":{"type":"string"}},"required":["self"],"additionalProperties":false},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"BaseResource":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBaseResource","description":"A resource identifier. Every resource object carries a unique `id` and a `type`, the resource type name such as `records` or `contributors`.","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"BaseResourceAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBaseResourceAttributes","description":"Timestamps on every resource's attributes, as ISO 8601 date-times. `created` marks the resource's creation; `updated` marks its last change.","type":"object","additionalProperties":false,"required":["created","updated"],"properties":{"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"}}},"LicensedMetadataConfigAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ILicensedMetadataConfigAttributes","description":"The tenant's licensed metadata provider config (read-only). The provider is enabled while this resource exists; delete it to disable the provider. Shows a partial preview of the API key, never the raw key.","type":"object","additionalProperties":false,"required":["provider","apiKeyConfigured","programsPollingIntervalMinutes","taxonomyPollingInterval","seedingStatus"],"properties":{"provider":{"type":"string","enum":["gracenote"],"description":"The licensed metadata provider this config enables."},"apiKeyConfigured":{"type":"boolean","description":"Whether the tenant has a stored API key for this provider."},"apiKeyPreview":{"type":"string","description":"First 2 and last 2 characters of the stored API key (e.g. \"gc••••9a\"), for display only. Absent until you store a key."},"programsPollingIntervalMinutes":{"type":"integer","enum":[15,30,45,60],"description":"How often to poll for program updates once the initial seed has caught up."},"taxonomyPollingInterval":{"type":"string","enum":["daily","weekly"],"description":"How often to check the provider's reference taxonomy for changes."},"pollingPaused":{"type":"boolean","description":"True when the tenant has paused steady-state polling. While paused:\n- both feeds stop polling, and a steady-state drain in flight stops at its next page, so polling spends no provider API quota\n- an initial seed job already running still finishes\n\nCursors, cached data and the cadence stay, so resuming continues where polling stopped without re-crawling. Absent means not paused."},"seedingStatus":{"type":"string","enum":["not_started","seeding","finished","failed"],"description":"Status of the initial data seed. Ongoing polling starts only once it reaches `finished`."},"seedingError":{"type":"string","description":"Why the initial seed failed. Present only when `seedingStatus` is `failed`."},"seedingStartedAt":{"type":"string","format":"date-time","description":"When the most recent initial seed started. Stays visible for the life of the integration, after the seed's background job expires (7 days). Absent until a seed has started."},"seedingFinishedAt":{"type":"string","format":"date-time","description":"When the most recent initial seed succeeded or failed. Absent while a seed is running, and on some older seeds."},"polling":{"type":"object","additionalProperties":false,"description":"Steady-state polling health per feed: shows whether ongoing ingestion works after the initial seed. A feed key is absent until that feed's first poll.","properties":{"programs":{"$ref":"#/components/schemas/LicensedMetadataFeedHealth"},"taxonomy":{"$ref":"#/components/schemas/LicensedMetadataFeedHealth"}}},"sandbox":{"type":"boolean","description":"True when this config uses the Fabric sandbox API key: its cached records are synthetic test data, not licensed Gracenote content. Sandbox titles carry a TMSId prefix Gracenote never issues (ZZ...), so you can spot them anywhere. Read-only, derived from the key."}}},"LicensedMetadataFeedHealth":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ILicensedMetadataFeedHealth","description":"Steady-state polling health of one licensed metadata feed. Present after the feed's first poll.","type":"object","additionalProperties":false,"required":["status"],"properties":{"status":{"type":"string","enum":["pending","ok","unauthorized","error"],"description":"Outcome of the most recent poll:\n- `pending`: scheduled, no poll completed yet\n- `ok`: succeeded\n- `unauthorized`: the provider rejected the API key; rotate it with `PATCH`\n- `error`: any other failure"},"lastPolledAt":{"type":"string","description":"ISO timestamp of the most recent poll attempt, whatever its outcome."},"lastSuccessAt":{"type":"string","description":"ISO timestamp of the most recent successful poll. If it goes stale while `status` is not `ok`, ingestion is failing."},"nextPollAt":{"type":"string","description":"Estimated ISO timestamp of the next poll: `lastPolledAt` plus the feed's interval. The schedule fires on a fixed cadence, so an interval change takes effect from the next tick."},"caughtUp":{"type":"boolean","description":"Whether the feed had no pending updates at the last successful poll."},"stalled":{"type":"boolean","description":"True when the feed is overdue: the current time is well past `nextPollAt`, so the scheduler seems to have stopped, not just gone idle. `status` and `message` keep the last known outcome and may look healthy; treat `stalled` as its own \"polling stopped\" signal. Absent while the feed polls on schedule."},"behindBy":{"type":"integer","description":"Approximate number of update-stream positions still pending at the last successful poll (0 when caught up)."},"message":{"type":"string","description":"What went wrong and what to do about it. Present for non-`ok` statuses."}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false},"ErrorResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IErrorResponse","description":"The body of a failed request: an `errors` array with one or more error objects.","type":"object","required":["errors","jsonapi"],"additionalProperties":false,"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"Error":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IError","description":"One JSON:API error object. `status` is the HTTP status code as a string, `title` a short summary and `detail` optional context. `meta` can carry structured conflict or authorization details.","type":"object","additionalProperties":false,"required":["status","title"],"properties":{"status":{"type":"string"},"title":{"type":"string"},"code":{"type":"string","description":"A stable code for the problem that you can act on, when the operation documents one."},"detail":{"type":"string"},"source":{"type":"object","description":"A JSON Pointer to the request field that caused the error, such as `/data/attributes/title`.","properties":{"pointer":{"type":"string"}}},"meta":{"type":"object","additionalProperties":true,"properties":{"stack":{"type":"string","description":"The error's stack trace. Non-production environments only."},"conflictItems":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"unauthorizedItems":{"type":"array","items":{"type":"string"}}}}}}}},"paths":{"/global/licensedMetadataConfigs/{licensedMetadataConfigId}":{"patch":{"summary":"Update a licensed metadata provider config","operationId":"licensedMetadataConfigUpdateOne","description":"Rotates the provider API key or changes the polling cadence and keeps the data already fetched. Changes only the attributes you send. The API key is write-only.","tags":["Licensed Metadata"],"parameters":[{"name":"licensedMetadataConfigId","description":"The config to update.","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLicensedMetadataConfigRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicensedMetadataConfigCreateOneResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## Start a licensed metadata config's initial data seed

> Starts a background job that loads the provider's initial data. A large entitlement can take a long time. Polling for updates starts only after the seed succeeds. One seed job runs at a time per config.

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"tags":[{"name":"Licensed Metadata","description":"Enable or disable a licensed metadata provider, such as Gracenote, for your tenant with your own API key. Your tenant's licensed data stays separate from other tenants'."}],"servers":[{"url":"{protocol}://{domain}/{basePath}","variables":{"protocol":{"enum":["http","https"],"default":"https"},"domain":{"default":"api.studio.fabricdata.com"},"basePath":{"default":"v1"}}}],"security":[{"jwt-apikey-authorizer":[]}],"components":{"securitySchemes":{"jwt-apikey-authorizer":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"BackgroundJobFindOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBackgroundJobFindOneResponse","description":"A single background job.","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["backgroundJobs"]},"attributes":{"$ref":"#/components/schemas/BackgroundJobAttributes"},"links":{"type":"object","properties":{"self":{"type":"string"}},"additionalProperties":false},"relationships":{"type":"object","properties":{"tenant":{"$ref":"#/components/schemas/TenantRelationship"},"author":{"$ref":"#/components/schemas/UserRelationship"}},"additionalProperties":false}},"required":["id","type","attributes"],"additionalProperties":false},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}},"required":["data","jsonapi"],"additionalProperties":false},"BackgroundJobAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBackgroundJobAttributes","description":"Attributes of a background job, a long-running operation such as a contributor delete or tenant data export. They carry the status, job type and parameters, plus the output on completion, error details on failure, and item counts for batch jobs.","type":"object","allOf":[{"$ref":"#/components/schemas/BaseResourceAttributes"},{"type":"object","properties":{"type":{"type":"string"},"parameters":{"type":"object"},"status":{"$ref":"#/components/schemas/BackgroundJobStatus"},"output":{"type":"object","properties":{"errorsAvailable":{"type":"boolean","description":"True when GET /backgroundJobs/{jobId}/errors can download the job's per-item error files."}}},"totalItemsCount":{"type":"integer","minimum":0,"description":"Total items in a batch job, when applicable."},"successItemsCount":{"type":"integer","minimum":0,"description":"Items the batch job processed successfully, when applicable."},"failedItemsCount":{"type":"integer","minimum":0,"description":"Items that failed in a batch job, when applicable."},"error":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"}},"required":["message","code"],"additionalProperties":false}},"required":["type","parameters","status"],"additionalProperties":false}],"additionalProperties":false},"BaseResourceAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBaseResourceAttributes","description":"Timestamps on every resource's attributes, as ISO 8601 date-times. `created` marks the resource's creation; `updated` marks its last change.","type":"object","additionalProperties":false,"required":["created","updated"],"properties":{"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"}}},"BackgroundJobStatus":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBackgroundJobStatus","description":"A background job's status. `RUNNING` and `PENDING_REDRIVE` (queued for retry) are still in progress; `SUCCEEDED`, `FAILED`, `TIMED_OUT` and `ABORTED` are final.","type":"string","enum":["ABORTED","FAILED","PENDING_REDRIVE","RUNNING","SUCCEEDED","TIMED_OUT"]},"TenantRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ITenantRelationship","description":"A relationship to a tenant","type":"object","properties":{"data":{"additionalProperties":false,"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["tenants"]}},"required":["id","type"]},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data","links"],"additionalProperties":false},"LinksRelated":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ILinks","description":"A JSON:API links object with an absolute or relative 'related' link","type":"object","required":["related"],"properties":{"related":{"type":"string"}},"additionalProperties":false},"UserRelationship":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUserRelationship","description":"A relationship to the actor behind a write, such as `author` or `updatedBy`. `data.meta.type` is the actor type: a human user, an API key or an internal service. Only human users carry `links.related`.","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["users"]},"meta":{"type":"object","properties":{"tenantId":{"type":"string"},"type":{"type":"string"},"displayName":{"type":"string"}},"required":["tenantId","type","displayName"],"additionalProperties":false}},"required":["id","type","meta"],"additionalProperties":false},"links":{"$ref":"#/components/schemas/LinksRelated"}},"required":["data"],"additionalProperties":false},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false},"ErrorResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IErrorResponse","description":"The body of a failed request: an `errors` array with one or more error objects.","type":"object","required":["errors","jsonapi"],"additionalProperties":false,"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"Error":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IError","description":"One JSON:API error object. `status` is the HTTP status code as a string, `title` a short summary and `detail` optional context. `meta` can carry structured conflict or authorization details.","type":"object","additionalProperties":false,"required":["status","title"],"properties":{"status":{"type":"string"},"title":{"type":"string"},"code":{"type":"string","description":"A stable code for the problem that you can act on, when the operation documents one."},"detail":{"type":"string"},"source":{"type":"object","description":"A JSON Pointer to the request field that caused the error, such as `/data/attributes/title`.","properties":{"pointer":{"type":"string"}}},"meta":{"type":"object","additionalProperties":true,"properties":{"stack":{"type":"string","description":"The error's stack trace. Non-production environments only."},"conflictItems":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"unauthorizedItems":{"type":"array","items":{"type":"string"}}}}}}}},"paths":{"/global/licensedMetadataConfigs/{licensedMetadataConfigId}/seedJob":{"post":{"summary":"Start a licensed metadata config's initial data seed","operationId":"licensedMetadataConfigSeedJobCreateOne","description":"Starts a background job that loads the provider's initial data. A large entitlement can take a long time. Polling for updates starts only after the seed succeeds. One seed job runs at a time per config.","tags":["Licensed Metadata"],"parameters":[{"name":"licensedMetadataConfigId","description":"The config to seed.","in":"path","required":true,"schema":{"type":"string"}},{"name":"maxIterations","description":"For testing only. Stops the seed after this many pages instead of loading the full entitlement. Omit in normal use.","in":"query","required":false,"schema":{"type":"integer","minimum":1}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackgroundJobFindOneResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict: a seed job is already running for this config","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```
