Represents a record of an API request made to the Connect server.
Type: objectProperties: 6
Password ManagerPasswordsSecuritySecrets
APIRequest is a JSON Structure definition published by 1Password, describing 6 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/1password/refs/heads/main/json-structure/1password-connect-api-request-structure.json",
"name": "APIRequest",
"description": "Represents a record of an API request made to the Connect server.",
"type": "object",
"properties": {
"requestId": {
"type": "uuid",
"description": "The unique identifier for the API request."
},
"timestamp": {
"type": "datetime",
"description": "When the request was made."
},
"action": {
"type": "string",
"description": "The HTTP method of the request."
},
"result": {
"type": "string",
"description": "The result status of the request.",
"enum": [
"SUCCESS",
"DENY"
]
},
"actor": {
"type": "object",
"description": "The actor who made the request.",
"properties": {
"id": {
"type": "uuid",
"description": "The unique identifier of the actor."
},
"account": {
"type": "string",
"description": "The account associated with the actor."
},
"jti": {
"type": "string",
"description": "The JWT token identifier."
},
"userAgent": {
"type": "string",
"description": "The user agent string of the client."
},
"requestIp": {
"type": "string",
"description": "The IP address of the client."
}
}
},
"resource": {
"type": "object",
"description": "The resource that was accessed.",
"properties": {
"type": {
"type": "string",
"description": "The type of resource."
},
"vault": {
"$ref": "#/components/schemas/VaultRef"
},
"item": {
"type": "object",
"properties": {
"id": {
"type": "uuid",
"description": "The unique identifier of the item."
}
}
},
"itemVersion": {
"type": "int32",
"description": "The version of the item."
}
}
}
}
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.