Search Storyblok's Documentation
  1. Create an Access Token

Create an Access Token

Create an access token for a particular space.

https://mapi.storyblok.com/v1/spaces/:space_id/api_keys/

Path Parameters

  • :space_id

    required number

    Numeric ID of a space

Request Body Properties

  • api_key

    The Access Token Object

    Access token object

    • access

      required string

      Type of token : public or private (preview token)

    • branch_id

      number

      Branch to which the token is associated to. Only if you are using the Pipelines application (null otherwise)

    • name

      string

      The name of the access token

    • story_ids

      number[]

      List of story IDs that can be accessed with the access token. Only if you are using the Access Token Scopes app.

    • min_cache

      number

      The minimum of seconds for the CDN cache. Default 0

Response Properties

  • api_key

    The Access Token Object

    Access token object

    • id

      number

      The numeric ID

    • access

      string

      Type of token : public or private (preview token)

    • branch_id

      number

      Branch to which the token is associated to. Only if you are using the Pipelines application (null otherwise)

    • name

      string

      The name of the access token

    • space_id

      number

      Numeric ID of a space

    • token

      string

      The token

    • story_ids

      number[]

      List of story IDs that can be accessed with the access token. Only if you are using the Access Token Scopes app.

    • min_cache

      number

      The minimum of seconds for the CDN cache. Default 0

Request
curl "https://mapi.storyblok.com/v1/spaces/606/api_keys/" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: YOUR_OAUTH_TOKEN" \
  -d "{\"api_key\": {\"access\": \"public\",\"name\": \"My public Access token\"}}"
Request
// Using the Universal JavaScript Client:
// https://github.com/storyblok/storyblok-js-client
Storyblok.post('/spaces/606/api_keys/', {
    "api_key": {
        "access": "public",
        "name": "My public Access token"
    }
})
  .then(response => {
    console.log(response)
  }).catch(error => { 
    console.log(error)
  })
Request
$client = new \Storyblok\ManagementClient('YOUR_OAUTH_TOKEN');

$payload = [
    "api_key" =>  [
        "access" =>  "public",
        "name" =>  "My public Access token"
    ]
];

$client->post('/spaces/606/api_keys/', $payload)->getBody();
Request
require 'storyblok'
client = Storyblok::Client.new(oauth_token: 'YOUR_OAUTH_TOKEN')

payload = {
    "api_key" =>  {
        "access" =>  "public",
        "name" =>  "My public Access token"
    }
}

client.post('/spaces/606/api_keys/', payload)
Request
HttpResponse<String> response = Unirest.post("https://mapi.storyblok.com/v1/spaces/606/api_keys/")
  .header("Content-Type", "application/json")
  .header("Authorization", "YOUR_OAUTH_TOKEN")
  .body("{\"api_key\": {\"access\": \"public\",\"name\": \"My public Access token\"}}")
  .asString();
Request
var client = new RestClient("https://mapi.storyblok.com/v1/spaces/606/api_keys/");
var request = new RestRequest(Method.POST);

request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "YOUR_OAUTH_TOKEN");
request.AddParameter("application/json", "{\"api_key\": {\"access\": \"public\",\"name\": \"My public Access token\"}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Request
import Foundation

let headers = [
  "Content-Type": "application/json",
  "Authorization": "YOUR_OAUTH_TOKEN"
]

let postData = NSData(data: "{\"api_key\": {\"access\": \"public\",\"name\": \"My public Access token\"}}".data(using: String.Encoding.utf8)!)
let request = NSMutableURLRequest(url: NSURL(string: "https://mapi.storyblok.com/v1/spaces/606/api_keys/")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0)

request.method = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
Request
import requests

url = "https://mapi.storyblok.com/v1/spaces/606/api_keys/"

querystring = {}

payload = "{\"api_key\": {\"access\": \"public\",\"name\": \"My public Access token\"}}"
headers = {
  'Content-Type': "application/json",
  'Authorization': "YOUR_OAUTH_TOKEN"
}

response = requests.request("POST", url, data=payload, headers=headers, params=querystring)

print(response.text)