Issue an agent licence

curl --request POST \
  --url https://api.meshqu.com/v1/agent-licences \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-MeshQu-Tenant-Id: <api-key>' \
  --data '
{
  "key_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "policy_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "policy_version_number": 2,
  "grant_authority": "<string>",
  "scope": [
    "<string>"
  ],
  "valid_from": "2023-11-07T05:31:56Z",
  "valid_until": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://api.meshqu.com/v1/agent-licences"

payload = {
    "key_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "policy_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "policy_version_number": 2,
    "grant_authority": "<string>",
    "scope": ["<string>"],
    "valid_from": "2023-11-07T05:31:56Z",
    "valid_until": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "X-MeshQu-Tenant-Id": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'X-MeshQu-Tenant-Id': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    key_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    policy_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    policy_version_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    policy_version_number: 2,
    grant_authority: '<string>',
    scope: ['<string>'],
    valid_from: '2023-11-07T05:31:56Z',
    valid_until: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.meshqu.com/v1/agent-licences', 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.meshqu.com/v1/agent-licences",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'key_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'policy_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'policy_version_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'policy_version_number' => 2,
    'grant_authority' => '<string>',
    'scope' => [
        '<string>'
    ],
    'valid_from' => '2023-11-07T05:31:56Z',
    'valid_until' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-MeshQu-Tenant-Id: <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.meshqu.com/v1/agent-licences"

	payload := strings.NewReader("{\n  \"key_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"policy_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"policy_version_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"policy_version_number\": 2,\n  \"grant_authority\": \"<string>\",\n  \"scope\": [\n    \"<string>\"\n  ],\n  \"valid_from\": \"2023-11-07T05:31:56Z\",\n  \"valid_until\": \"2023-11-07T05:31:56Z\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-MeshQu-Tenant-Id", "<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.post("https://api.meshqu.com/v1/agent-licences")
  .header("Authorization", "Bearer <token>")
  .header("X-MeshQu-Tenant-Id", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"key_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"policy_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"policy_version_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"policy_version_number\": 2,\n  \"grant_authority\": \"<string>\",\n  \"scope\": [\n    \"<string>\"\n  ],\n  \"valid_from\": \"2023-11-07T05:31:56Z\",\n  \"valid_until\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.meshqu.com/v1/agent-licences")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-MeshQu-Tenant-Id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"key_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"policy_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"policy_version_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"policy_version_number\": 2,\n  \"grant_authority\": \"<string>\",\n  \"scope\": [\n    \"<string>\"\n  ],\n  \"valid_from\": \"2023-11-07T05:31:56Z\",\n  \"valid_until\": \"2023-11-07T05:31:56Z\"\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "record_type": "grant",
  "key_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "revokes_licence_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "granted_by": "<string>",
  "grant_authority": "<string>",
  "policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "policy_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "policy_version_number": 123,
  "scope": [
    "<string>"
  ],
  "valid_from": "2023-11-07T05:31:56Z",
  "valid_until": "2023-11-07T05:31:56Z",
  "issued_at": "2023-11-07T05:31:56Z",
  "licence_digest": "<string>",
  "grantor_signature": {
    "signature": "<string>",
    "signature_kid": "<string>",
    "signature_algorithm": "ed25519"
  },
  "created_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  },
  "correlation_id": "<string>"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  },
  "correlation_id": "<string>"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  },
  "correlation_id": "<string>"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  },
  "correlation_id": "<string>"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  },
  "correlation_id": "<string>"
}

Agent Licences

Issue an agent licence

Creates an agent licence record binding an API key to a policy version, a scope and a validity window. Requires a verified human principal; an API key receives 403 HUMAN_PRINCIPAL_REQUIRED. 409 AGENT_LICENCE_POLICY_VERSION_NOT_IN_FORCE when the named version exists, matches policy_id and policy_version_number, and is not ratified and in force, or its policy is archived; a version id that does not exist or does not match still answers 500. 409 AGENT_LICENCE_FUTURE_START_WHILE_LIVE when valid_from is after now and the key holds a licence in force now (details.live_licence_id names it); the new licence would govern at once and leave the key unlicensed until it starts. Neither writes anything. 500 AGENT_LICENCE_READBACK_FAILED means the licence WAS committed and only the read of it afterwards came back empty or failed (details.committed is true); read it back rather than issuing again, since a second licence would govern in place of the first.

POST

agent-licences

curl --request POST \
  --url https://api.meshqu.com/v1/agent-licences \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-MeshQu-Tenant-Id: <api-key>' \
  --data '
{
  "key_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "policy_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "policy_version_number": 2,
  "grant_authority": "<string>",
  "scope": [
    "<string>"
  ],
  "valid_from": "2023-11-07T05:31:56Z",
  "valid_until": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://api.meshqu.com/v1/agent-licences"

payload = {
    "key_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "policy_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "policy_version_number": 2,
    "grant_authority": "<string>",
    "scope": ["<string>"],
    "valid_from": "2023-11-07T05:31:56Z",
    "valid_until": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "X-MeshQu-Tenant-Id": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'X-MeshQu-Tenant-Id': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    key_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    policy_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    policy_version_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    policy_version_number: 2,
    grant_authority: '<string>',
    scope: ['<string>'],
    valid_from: '2023-11-07T05:31:56Z',
    valid_until: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.meshqu.com/v1/agent-licences', 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.meshqu.com/v1/agent-licences",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'key_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'policy_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'policy_version_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'policy_version_number' => 2,
    'grant_authority' => '<string>',
    'scope' => [
        '<string>'
    ],
    'valid_from' => '2023-11-07T05:31:56Z',
    'valid_until' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-MeshQu-Tenant-Id: <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.meshqu.com/v1/agent-licences"

	payload := strings.NewReader("{\n  \"key_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"policy_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"policy_version_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"policy_version_number\": 2,\n  \"grant_authority\": \"<string>\",\n  \"scope\": [\n    \"<string>\"\n  ],\n  \"valid_from\": \"2023-11-07T05:31:56Z\",\n  \"valid_until\": \"2023-11-07T05:31:56Z\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-MeshQu-Tenant-Id", "<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.post("https://api.meshqu.com/v1/agent-licences")
  .header("Authorization", "Bearer <token>")
  .header("X-MeshQu-Tenant-Id", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"key_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"policy_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"policy_version_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"policy_version_number\": 2,\n  \"grant_authority\": \"<string>\",\n  \"scope\": [\n    \"<string>\"\n  ],\n  \"valid_from\": \"2023-11-07T05:31:56Z\",\n  \"valid_until\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.meshqu.com/v1/agent-licences")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-MeshQu-Tenant-Id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"key_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"policy_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"policy_version_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"policy_version_number\": 2,\n  \"grant_authority\": \"<string>\",\n  \"scope\": [\n    \"<string>\"\n  ],\n  \"valid_from\": \"2023-11-07T05:31:56Z\",\n  \"valid_until\": \"2023-11-07T05:31:56Z\"\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "record_type": "grant",
  "key_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "revokes_licence_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "granted_by": "<string>",
  "grant_authority": "<string>",
  "policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "policy_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "policy_version_number": 123,
  "scope": [
    "<string>"
  ],
  "valid_from": "2023-11-07T05:31:56Z",
  "valid_until": "2023-11-07T05:31:56Z",
  "issued_at": "2023-11-07T05:31:56Z",
  "licence_digest": "<string>",
  "grantor_signature": {
    "signature": "<string>",
    "signature_kid": "<string>",
    "signature_algorithm": "ed25519"
  },
  "created_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  },
  "correlation_id": "<string>"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  },
  "correlation_id": "<string>"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  },
  "correlation_id": "<string>"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  },
  "correlation_id": "<string>"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  },
  "correlation_id": "<string>"
}

Authorizations

Authorization

string

header

required

MeshQu API key passed as a bearer token: Authorization: Bearer mqu_…. Mint one in the console (Settings → API keys).

X-MeshQu-Tenant-Id

string

header

required

Tenant UUID for multi-tenant isolation. Required on authenticated routes. A missing or non-UUID value returns 400 MISSING_TENANT_ID or INVALID_TENANT_ID before API-key authentication.

Body

application/json

key_id

string<uuid>

required

ID of the API key this record refers to.

policy_id

string<uuid>

required

policy_version_id

string<uuid>

required

A policy version id belonging to policy_id in this tenant.

policy_version_number

integer

required

The version number of policy_version_id.

Required range: x >= 1

grant_authority

string

required

Required string length: 1 - 512

scope

string[]

required

decision_type values, matched byte-exactly and case-sensitively.

Required array length: 1 - 100 elements

Required string length: 1 - 256

valid_from

string<date-time>

required

valid_until

string<date-time>

required

Response

An agent licence record: a grant, or the revocation that supersedes one.

string<uuid>

required

tenant_id

string<uuid>

required

record_type

required

Available options:

grant

key_id

string<uuid>

required

revokes_licence_id

string<uuid> | null

required

granted_by

string

required

grant_authority

string

required

policy_id

string<uuid>

required

policy_version_id

string<uuid>

required

policy_version_number

integer

required

scope

string[]

required

valid_from

string<date-time>

required

valid_until

string<date-time>

required

issued_at

string<date-time>

required

licence_digest

string

required

Pattern: ^[0-9a-f]{64}$

grantor_signature

object

required

Show child attributes

created_at

string<date-time>

required

Getting Started

Concepts

API Reference

SDK

Guides

Recipes

Security

Meta

Issue an agent licence

Authorizations

Body

Response