Update an API key

PATCH /projects/{projectIdOrName}/api-keys/{apiKey}

Update an API key

cURL

curl --request PATCH \
  --url https://api.withampersand.com/v1/projects/{projectIdOrName}/api-keys/{apiKey} \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "updateMask": [
    "active",
    "label"
  ],
  "apiKey": {
    "label": "MailMonkey API Key",
    "active": true,
    "scopes": [
      [
        "full",
        "frontend"
      ]
    ]
  }
}
'

import requests

url = "https://api.withampersand.com/v1/projects/{projectIdOrName}/api-keys/{apiKey}"

payload = {
    "updateMask": ["active", "label"],
    "apiKey": {
        "label": "MailMonkey API Key",
        "active": True,
        "scopes": [["full", "frontend"]]
    }
}
headers = {
    "X-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    updateMask: ['active', 'label'],
    apiKey: {label: 'MailMonkey API Key', active: true, scopes: [['full', 'frontend']]}
  })
};

fetch('https://api.withampersand.com/v1/projects/{projectIdOrName}/api-keys/{apiKey}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.withampersand.com/v1/projects/{projectIdOrName}/api-keys/{apiKey}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'updateMask' => [
        'active',
        'label'
    ],
    'apiKey' => [
        'label' => 'MailMonkey API Key',
        'active' => true,
        'scopes' => [
                [
                                'full',
                                'frontend'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.withampersand.com/v1/projects/{projectIdOrName}/api-keys/{apiKey}"

	payload := strings.NewReader("{\n  \"updateMask\": [\n    \"active\",\n    \"label\"\n  ],\n  \"apiKey\": {\n    \"label\": \"MailMonkey API Key\",\n    \"active\": true,\n    \"scopes\": [\n      [\n        \"full\",\n        \"frontend\"\n      ]\n    ]\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-Api-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.withampersand.com/v1/projects/{projectIdOrName}/api-keys/{apiKey}")
  .header("X-Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"updateMask\": [\n    \"active\",\n    \"label\"\n  ],\n  \"apiKey\": {\n    \"label\": \"MailMonkey API Key\",\n    \"active\": true,\n    \"scopes\": [\n      [\n        \"full\",\n        \"frontend\"\n      ]\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.withampersand.com/v1/projects/{projectIdOrName}/api-keys/{apiKey}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"updateMask\": [\n    \"active\",\n    \"label\"\n  ],\n  \"apiKey\": {\n    \"label\": \"MailMonkey API Key\",\n    \"active\": true,\n    \"scopes\": [\n      [\n        \"full\",\n        \"frontend\"\n      ]\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body

200

{
  "key": "api-key-123",
  "label": "MailMonkey API Key",
  "scopes": [
    [
      "full",
      "frontend"
    ]
  ],
  "projectId": "my-project",
  "active": true
}

{
  "type": "about:blank",
  "href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types",
  "title": "Bad Request",
  "status": 400,
  "detail": "The input message is incorrect",
  "instance": "123456-1234-1235-4567489798",
  "issues": [
    {
      "type": "about:blank",
      "detail": "exampleNumericProperty should be numeric",
      "in": "path",
      "name": "exampleNumericProperty",
      "value": "abc"
    },
    {
      "type": "about:blank",
      "title": "Input isn't valid with respect to schema",
      "detail": "examplePropertyWithPattern a2345678901 doesn't match pattern '^\\d{11}$'",
      "in": "body",
      "name": "items[0].examplePropertyWithPattern",
      "value": "a2345678901"
    }
  ]
}

{
  "type": "about:blank",
  "href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types",
  "title": "Bad Request",
  "status": 400,
  "detail": "The input message is incorrect",
  "instance": "123456-1234-1235-4567489798",
  "issues": [
    {
      "type": "about:blank",
      "detail": "exampleNumericProperty should be numeric",
      "in": "path",
      "name": "exampleNumericProperty",
      "value": "abc"
    },
    {
      "type": "about:blank",
      "title": "Input isn't valid with respect to schema",
      "detail": "examplePropertyWithPattern a2345678901 doesn't match pattern '^\\d{11}$'",
      "in": "body",
      "name": "items[0].examplePropertyWithPattern",
      "value": "a2345678901"
    }
  ]
}

{
  "type": "about:blank",
  "href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types",
  "title": "Bad Request",
  "status": 400,
  "detail": "The input message is incorrect",
  "instance": "123456-1234-1235-4567489798",
  "issues": [
    {
      "type": "about:blank",
      "detail": "exampleNumericProperty should be numeric",
      "in": "path",
      "name": "exampleNumericProperty",
      "value": "abc"
    },
    {
      "type": "about:blank",
      "title": "Input isn't valid with respect to schema",
      "detail": "examplePropertyWithPattern a2345678901 doesn't match pattern '^\\d{11}$'",
      "in": "body",
      "name": "items[0].examplePropertyWithPattern",
      "value": "a2345678901"
    }
  ]
}

{
  "type": "urn:problem-type:exampleOrganization:exampleProblem",
  "href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types",
  "title": "Description of the type of problem that occurred",
  "status": 400,
  "detail": "Description of specific occurrence of the problem",
  "instance": "urn:uuid:123e4567-e89b-12d3-a456-426614174000"
}

Authorizations

APIKeyHeaderBearer

X-Api-Key · string · header · required

Path Parameters

projectIdOrName · string · required

The Ampersand project ID or project name.

apiKey · string · required

API key to access Ampersand APIs.

Body

application/json

updateMask · string[] · required

Array of field paths specifying which fields to update. Allowed values include:

• active
• label
• scopes

Example:

["active", "label"]

apiKey · object · required

Show child attributes

Response

200

application/json

API key updated

key · string · required

The API key.

Example:

"api-key-123"

label · string · required

A short name for the API key.

Example:

"MailMonkey API Key"

scopes · string[] · required

The scopes for the API key.

projectId · string · required

The project ID.

Example:

"my-project"

active · boolean

Whether the API key is active.

Example:

true