Create a credential; the secret is returned once

POST

/api-credentials

const url = 'https://acme.gravitastec.com/api/v1/api-credentials';
const options = {
  method: 'POST',
  headers: {
    cookie: '__Host-gravitas=<__Host-gravitas>',
    'Content-Type': 'application/json'
  },
  body: '{"name":"example","environmentClass":"test","allCompanies":false,"companyIds":["2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://acme.gravitastec.com/api/v1/api-credentials \
  --header 'Content-Type: application/json' \
  --cookie __Host-gravitas=<__Host-gravitas> \
  --data '{ "name": "example", "environmentClass": "test", "allCompanies": false, "companyIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ] }'

Authorizations

portalSession

Request Body^required

application/json

object

name

required

string

<= 100 characters

environmentClass

required

string

Allowed values: test production

allCompanies

boolean

companyIds

Array<string>

Responses

201

Created

application/json

object

string format: uuid

clientId

string

name

string

environmentClass

string

Allowed values: test production

allCompanies

boolean

companyIds

Array<string>

status

string

Allowed values: active revoked

lastUsedAt

string | null format: date-time

clientSecret

Shown only once

string

Example

{
  "environmentClass": "test",
  "status": "active"
}

403

Limit_exceeded (plan without API access

Create a credential; the secret is returned once

Authorizations

Request Bodyrequired

Responses

201

Example

403

Request Body^required