Resource Names: List
Get a list of resource names for an account for a given resource type.
resourceGroup and resourceSubType combine to describe the type of resource to query.
Examples: km/entity, platform/account-features.
path Parameters
| accountId required | string |
| resourceGroup required | string Group of the resource For example, for |
| resourceSubType required | string Subtype of the resource For example, for |
query Parameters
| v required | string A date in |
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": [
- "string"
]
}Resource Configuration: Get
Get a resource configuration.
resourceGroup and resourceSubType combine to describe the type of resource to return.
Examples: km/entity, platform/account-features.
resourceId describes the specific resource to return, matching the $id field of the resource configuration.
To return the resource configuration of singleton resources (resources without $id fields like km/settings and platform/account-features), specify config as the resourceId.
Example: platform/account-features/config
path Parameters
| accountId required | string |
| resourceId required | string $id (name) of the resource |
| resourceGroup required | string Group of the resource For example, for |
| resourceSubType required | string Subtype of the resource For example, for |
query Parameters
| v required | string A date in |
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": { }
}Resource Configuration: Update
Update a resource configuration. It overwrites the existing resource entirely.
resourceGroup and resourceSubType combine to describe the type of resource to return.
Examples: km/entity, platform/account-features.
resourceId describes the specific resource to return, matching the $id field of the resource configuration.
To update the resource configuration of singleton resources (resources without $id fields like km/settings and platform/account-features), specify config as the resourceId.
Example: platform/account-features/config
path Parameters
| accountId required | string |
| resourceId required | string $id (name) of the resource |
| resourceGroup required | string Group of the resource For example, for |
| resourceSubType required | string Subtype of the resource For example, for |
query Parameters
| v required | string A date in |
Request Body schema: application/json
A JSON representation of the resource. Please refer to the Hitchhiker's guide for the exact resource schema.
Responses
Request samples
- Payload
{ }Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": { }
}Resource Configuration: Patch
Patch a resource configuration. It only updates the provided attributes and keeps the existing attributes intact.
resourceGroup and resourceSubType combine to describe the type of resource to return.
Examples: km/entity, platform/account-features.
resourceId describes the specific resource to return, matching the $id field of the resource configuration.
To patch the resource configuration of singleton resources (resources without $id fields like km/settings and platform/account-features), specify config as the resourceId.
Example: platform/account-features/config
path Parameters
| accountId required | string |
| resourceId required | string $id (name) of the resource |
| resourceGroup required | string Group of the resource For example, for |
| resourceSubType required | string Subtype of the resource For example, for |
query Parameters
| v required | string A date in |
Request Body schema: application/json
A JSON representation of the resource. Please refer to the Hitchhiker's guide for the exact resource schema.
Responses
Request samples
- Payload
{ }Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": { }
}Resource Configuration: Create
Create a new resource for a given resource type.
resourceGroup and resourceSubType combine to describe the type of resource to create.
Examples: km/entity, platform/account-features.
path Parameters
| accountId required | string |
| resourceGroup required | string Group of the resource For example, for |
| resourceSubType required | string Subtype of the resource For example, for |
query Parameters
| v required | string A date in |
Request Body schema: application/json
A JSON representation of the resource. Please refer to the Hitchhiker's guide for the exact resource schema.
Responses
Request samples
- Payload
{ }Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": { }
}