> For the complete documentation index, see [llms.txt](https://guide.data.gov.sg/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://guide.data.gov.sg/user-guide/for-data-owners/how-to-generate-api-keys.md).

# How to generate API keys

{% hint style="info" %}
Please manage your API keys securely - do not share these with your colleagues or vendors
{% endhint %}

* API Keys are only needed for `Write Operations` - operations that require the pushing/uploading of data programmatically.&#x20;
* `Read Operations` to pull information from Data.gov do not require API Keys.&#x20;
* For smoother integration, consider using an admin account accessible by multiple users in your agency.&#x20;
* **Do not share** this API key with third parties such as vendors.

1. Navigate to the API Keys tab

<figure><img src="https://2014478147-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fksq6aNCGbng1fqooERfi%2Fuploads%2FfO5qWsbBC2qyUUzeyiQs%2FScreenshot%202024-02-15%20at%2012.51.01%20PM.png?alt=media&amp;token=eec8946b-8a4f-4fbd-b0d3-6cbf78351827" alt=""><figcaption><p>The API Keys Page on Data.gov </p></figcaption></figure>

> Before beginning the API Key creation process, note that the key you create will grant access to the permissions your account currently. Do ensure that this key is only created/shared with the intention of sharing your accounts' permissions.&#x20;

2. Proceed to name your key under the `Key Name` text box.&#x20;

<figure><img src="https://2014478147-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fksq6aNCGbng1fqooERfi%2Fuploads%2FkcFjHEcjg8jpgxRAqYq0%2FScreenshot%202024-02-15%20at%2012.56.53%20PM.png?alt=media&amp;token=f45d50f8-778e-49a1-b3d6-e67a43e82e8d" alt=""><figcaption></figcaption></figure>

3. Indicate the lifespan of your key via selecting an option on the drop down menu, under `Expiration.` Do note that multiple keys can exist at the same time, and new keys can be created in the event your current key is set to expire.&#x20;

<figure><img src="https://2014478147-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fksq6aNCGbng1fqooERfi%2Fuploads%2FR3CZf89TqOZxs5vTOzUF%2FScreenshot%202024-02-15%20at%201.00.35%20PM.png?alt=media&amp;token=9c024cd5-42f6-4961-a70b-51f667b68bee" alt=""><figcaption></figcaption></figure>

For further queries feel free to reach out to us: [Contact the Data.gov.sg team](https://form.gov.sg/6449e5c3664c1b001249acf1)
