# ApiKeyStatus

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

The administrative state of an API key: either it is in service, or someone took it out of
service permanently.

## Values

| Value | Description |
| --- | --- |
| `Active` | The key is in service. Whether it is currently accepted also depends on its expiry. |
| `Revoked` | The key has been revoked and is rejected at authentication for good. Revoked keys are retained rather than deleted so the audit trail of what the key did survives it. |
| `Suspended` | The key has been put out of service temporarily, pending someone deciding whether the use that triggered it was legitimate. Rejected at authentication exactly as a revoked key is, and reinstatable, which is the whole reason it is not one. |

## See also

- [All documentation](https://devportal.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.