ApiKey

Source:

entities/api-key.js, line 1

Api Key instances

Type Definitions

Source:

entities/api-key.js, line 14

Properties:

Name	Type	Description
`sys`	Meta.Sys	System metadata
`name`	string
`description`	string
`toPlainObject()`	function	Returns this Api Key as a plain JS object

Methods

(static) delete() → {Promise}

Source:

entities/api-key.js, line 51

Deletes this object on the server.

Example

const contentful = require('contentful-management')

const client = contentful.createClient({
  accessToken: '<content_management_api_key>'
})
client.getSpace('<space_id>')
.then((space) => space.getApiKey(<api-key-id>))
.then((apiKey) => apiKey.delete())
.then(() => console.log('apikey deleted'))
.catch(console.error)

Returns:

Promise for the deletion. It contains no data, but the Promise error case should be handled.

Type: Promise

(static) update() → {Promise.<ApiKey>}

Source:

entities/api-key.js, line 25

Sends an update to the server with any changes made to the object's properties

Example

const contentful = require('contentful-management')

const client = contentful.createClient({
  accessToken: '<content_management_api_key>'
})
client.getSpace('<space_id>')
.then((space) => space.getApiKey(<api-key-id>))
.then((apiKey) => {
 apiKey.name = 'New name'
 return apiKey.update()
})
.then(apiKey => console.log(apiKey.name))
.catch(console.error)

Returns:

Object returned from the server with updated changes.

Type: Promise.<ApiKey>