2020-01-01 22:37:59 +01:00
---
title: Application
2020-01-12 14:11:56 +01:00
description: Represents an application that interfaces with the REST API to access accounts or post statuses.
2020-01-01 22:37:59 +01:00
menu:
docs:
parent: entities
---
## Example
```javascript
{
"name": "test app",
"website": null,
"vapid_key": "BCk-QqERU0q-CfYZjcuB6lnyyOYfJ2AifKqfeGIm7Z-HiTU5T9eTG5GxVA0_OH5mMlI4UkkDTpaZwozy0TzdZ2M="
}
```
## Required attributes
2020-01-12 14:11:56 +01:00
### `name` {#name}
2020-01-01 22:37:59 +01:00
2020-01-12 14:11:56 +01:00
**Description:** The name of your application.\
**Type:** String\
2020-01-01 22:37:59 +01:00
**Version history:** Added in 0.9.9
## Optional attributes
2020-01-12 14:11:56 +01:00
### `website` {#website}
2020-01-01 22:37:59 +01:00
2020-01-12 14:11:56 +01:00
**Description:** The website associated with your application.\
**Type:** String \(URL\)\
2020-01-01 22:37:59 +01:00
**Version history:** Added in 0.9.9
2020-01-12 14:11:56 +01:00
### `vapid_key` {#vapid_key}
2020-01-01 22:37:59 +01:00
2020-08-10 23:01:50 +02:00
**Description:** Used for Push Streaming API. Returned with [POST /api/v1/apps ]({{< relref "../methods/apps/#create-an-application" >}} ). Equivalent to [PushSubscription\#server\_key ]({{< relref "pushsubscription.md#server_key" >}} )\
2020-01-12 14:11:56 +01:00
**Type:** String\
2020-01-01 22:37:59 +01:00
**Version history:** Added in 2.8.0
## Client attributes
2020-01-12 14:11:56 +01:00
### `client_id` {#client_id}
2020-01-01 22:37:59 +01:00
2020-01-12 14:11:56 +01:00
**Description:** Client ID key, to be used for obtaining OAuth tokens\
**Type:** String\
2020-01-01 22:37:59 +01:00
**Version history:** Added in 0.9.9
2020-01-12 14:11:56 +01:00
### `client_secret` {#client_secret}
2020-01-01 22:37:59 +01:00
2020-01-12 14:11:56 +01:00
**Description:** Client secret key, to be used for obtaining OAuth tokens\
**Type:** String\
2020-01-01 22:37:59 +01:00
**Version history:** Added in 0.9.9
## See also
2020-08-10 23:01:50 +02:00
* [Status\#application ]({{< relref "status.md#application" >}} )
* [Create an application \(POST /api/v1/apps\) ]({{< relref "../methods/apps/#create-an-application" >}} )
2020-01-01 22:37:59 +01:00
{{< page-ref page = "status.md" > }}
{{< page-ref page = "methods/apps.md" > }}
{{< caption-link url = "https://github.com/tootsuite/mastodon/blob/master/app/serializers/rest/application_serializer.rb" caption = "app/serializers/rest/application \_serializer.rb" > }}