Get Configuration Templates

1 min

GET

https://api.upstartcommerce.com/v1/tenants/cfg/templates

This endpoint retrieves the cfg templates data for a given tenant.

Authorized permissions:

tenant.cfg.read

Header Parameters

x-upstart-tenantstringrequired
Description
Tenant identifier associated with the site this call is for.

Responses

200

Success-templates returned.

CfgTemplate[]
Example
```
[
  {
    "tenant": "acme001",
    "domain": "acme-retail",
    "templateId": "payment-cybersource",
    "name": "Cybersource Payment Gateway",
    "propertiesDec": {
      "type": "object",
      "properties": {
        "merchantId": {
          "type": "string"
        },
        "apiKey": {
          "type": "string",
          "format": "password"
        }
      },
      "required": [
        "merchantId",
        "apiKey"
      ]
    },
    "enabled": true,
    "version": 2,
    "accessControl": {
      "read": true,
      "modify": false
    },
    "audit": {
      "by": "[email protected]",
      "byAnonymous": false,
      "at": "2024-01-15T10:00:00Z",
      "traceId": "abc123",
      "serviceName": "tenant-svc",
      "serviceVersion": "1.0.0"
    }
  },
  {
    "tenant": "acme001",
    "domain": "acme-retail",
    "templateId": "media-cloudinary",
    "name": "Cloudinary Media Storage",
    "propertiesDec": {
      "type": "object",
      "properties": {
        "cloudName": {
          "type": "string"
        },
        "apiKey": {
          "type": "string"
        }
      },
      "required": [
        "cloudName"
      ]
    },
    "enabled": true,
    "version": 1,
    "accessControl": {
      "read": true,
      "modify": true
    },
    "audit": {
      "by": "[email protected]",
      "byAnonymous": false,
      "at": "2024-01-10T08:00:00Z",
      "traceId": "def456",
      "serviceName": "tenant-svc",
      "serviceVersion": "1.0.0"
    }
  }
]
```
Description
A configuration template defines the schema and structure for configuration records. Templates act as blueprints that specify what fields configuration records must/can contain, their types, validation rules, and documentation. Templates enable type-safe configuration management across integrations and services. For example, a 'Cybersource Payment Gateway' template would define fields like merchantId, apiKey, apiUrl with appropriate types and constraints.
- tenantstring
  Example
  acme-retail
  Description
  The unique identifier of the tenant that owns this configuration template. Templates are isolated by tenant for multi-tenancy, allowing each tenant to customize or extend templates.
- domainstringrequired
  Example
  acme
  Description
  The domain name associated with the tenant. This is the subdomain prefix used to access the tenant's portal (e.g., 'acme' in 'acme.upstartcommerce.com').
- templateIdstringrequired
  Example
  payment-cybersource
  Description
  The unique identifier for this configuration template. Used to associate records with their template. Should be descriptive and follow naming conventions (e.g., 'payment-cybersource', 'shipping-fedex', 'media-cloudinary'). Cannot be changed after creation.
- namestringrequired
  Example
  Cybersource Payment Gateway Configuration
  Description
  A human-readable name for this configuration template. Displayed in administrative UI and documentation. Should clearly describe the purpose of configurations using this template (e.g., 'Cybersource Payment Gateway Configuration', 'Cloudinary Media Storage').
- propertiesDecobjectrequired
  Example
```
{
  "type": "object",
  "properties": {
    "merchantId": {
      "type": "string",
      "description": "Cybersource merchant identifier"
    },
    "apiKey": {
      "type": "string",
      "description": "API key for authentication",
      "format": "password"
    },
    "apiUrl": {
      "type": "string",
      "format": "uri",
      "default": "https://api.cybersource.com"
    }
  },
  "required": [
    "merchantId",
    "apiKey"
  ]
}
```
  Description
  Properties Descriptors (abbreviated as 'propertiesDec'): The JSON schema defining the structure of the 'data' field in records created from this template. This descriptor specifies field names, types, required vs optional fields, validation rules, default values, and field documentation. Follows JSON Schema specification. This is the core of the template that enforces data structure and validation.
- enabledbooleanrequired
  Example
  true
  Description
  Indicates whether this configuration template is currently active and can be used to create new records. When false, existing records continue to work but new records cannot be created with this template. Use this to deprecate old templates while maintaining backward compatibility.
- versionintegerrequired
  Example
  3
  Description
  The version number of this configuration template, incremented with each update. Used for schema versioning and migration tracking. Records store the template version they were created with, enabling schema evolution and backward compatibility.
- accessControlCfgAccessControlrequired
  Description
  Access control settings that determine which operations can be performed on a configuration resource. This enables fine-grained permission management for configuration templates and records.
  - readbooleanrequired
    Example
    true
    Description
    Whether the configuration resource can be read/viewed. When false, the resource is hidden from queries and detail views unless the user has elevated privileges. Typically used for sensitive configurations.
  - modifybooleanrequired
    Description
    Whether the configuration resource can be modified (updated or deleted). When false, the resource becomes read-only and cannot be changed through the API. Useful for protecting production configurations.
- auditAuditrequired
  Description
  Audit information tracking who performed an action, when, and from which system. This provides a complete audit trail for compliance and debugging purposes.
  - byIdstring
    Description
    The unique identifier of the user or system that performed this action. This could be a user ID, service account ID, or system identifier.
  - bystringrequired
    Description
    The human-readable name or email of the user/system that performed the action. Used for display purposes in audit logs and UI.
  - byAnonymousbooleanrequired
    Description
    Indicates whether this action was performed by an anonymous user (true) or an authenticated user/system (false). Anonymous actions have limited audit information.
  - atstring<date-time>required
    Example
    2024-01-15T10:30:00Z
    Description
    The exact timestamp when this action occurred, in ISO 8601 format (e.g., '2024-01-15T10:30
    '). Always in UTC timezone.
    Format
    date-time
  - traceIdstringrequired
    Example
    550e8400-e29b-41d4-a716-446655440000
    Description
    A unique identifier for tracing this request across distributed services. Used for correlating logs and debugging issues across the system. Typically a UUID.
  - serviceNamestringrequired
    Example
    tenant-svc
    Description
    The name of the microservice that processed this request (e.g., 'tenant-svc', 'cart-svc'). Used for identifying which service performed the action.
  - serviceVersionstringrequired
    Example
    1.2.3
    Description
    The version of the service that processed this request (e.g., '1.2.3', 'v2.0.0'). Useful for tracking behavior changes across deployments.
  - byDomainstring
    Example
    example-store
    Description
    The domain or tenant context from which the action was performed. Used in multi-tenant scenarios to track cross-tenant operations.
  - bySubjectTypestring
    Example
    USER
    Description
    The type of subject that performed the action (e.g., 'USER', 'SERVICE_ACCOUNT', 'SYSTEM'). Helps categorize audit entries by actor type.

400The request contained information that the server was unable to process. Appropriate errors are provided in the response body.

ValidationErrorResponse
Example
```
{
  "name": "ValidationError",
  "code": "SCHEMA_VALIDATION_FAILED",
  "detail": "Configuration data validation failed: data.apiKey is required but was not provided. Expected string with minimum length 32."
}
```
Description
Error response returned when request validation fails (HTTP 400). Contains details about which fields failed validation and why. Used for client-side error display and form validation feedback. Common when configuration data doesn't match template schema.
- namestringrequired
  Example
  ValidationError
  Description
  The error type, typically 'ValidationError' for all validation failures. Use this to distinguish validation errors from other error types in your error handling logic.
- codestringrequired
  Example
  SCHEMA_VALIDATION_FAILED
  Description
  A validation-specific error code indicating the validation rule that failed. Examples include 'REQUIRED_FIELD_MISSING', 'INVALID_FORMAT', 'VALUE_OUT_OF_RANGE', 'SCHEMA_VALIDATION_FAILED', 'TEMPLATE_NOT_FOUND'. Use for specific handling of different validation scenarios.
- detailstring
  Example
  Configuration data validation failed: data.apiKey is required but was not provided. Expected string with minimum length 32.
  Description
  Human-readable validation error message describing which field(s) failed and why. Includes specific details about what was expected vs what was provided. For schema validation failures, may include JSON path to the invalid field (e.g., 'data.apiKey is required but was not provided').

401The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.

ErrorResponse
Example
```
{
  "name": "AuthorizationError",
  "code": "INSUFFICIENT_PERMISSIONS",
  "detail": "User does not have the required tenant.cfg.modify permission to perform this operation.",
  "reason": "Your access token does not include the necessary permissions. Contact your administrator to request access."
}
```
Description
Standard error response returned when a request fails due to business logic, authorization, or system errors. Provides structured information for debugging and user-facing error messages.
- namestringrequired
  Example
  ResourceNotFoundError
  Description
  The high-level error category or type name. This is a machine-readable identifier for the class of error (e.g., 'AuthorizationError', 'ResourceNotFoundError', 'ValidationError'). Use this for programmatic error handling.
- codestringrequired
  Example
  TEMPLATE_NOT_FOUND
  Description
  A specific error code identifying the exact error condition. More granular than name, this code can be used for precise error handling and localization. Format is typically uppercase with underscores (e.g., 'TEMPLATE_NOT_FOUND', 'INSUFFICIENT_PERMISSIONS').
- detailstringrequired
  Example
  The configuration template with ID "payment-stripe" was not found in the system.
  Description
  A human-readable description of the error, including context about what went wrong. This message is suitable for display to end users or inclusion in logs. May include specifics like resource IDs or field names.
- reasonstring
  Example
  The template may have been deleted or you may not have permission to access it. Verify the template ID using GET /tenants/cfg/templates.
  Description
  Optional additional context explaining why the error occurred or what action the user should take. May include suggestions for resolution, links to documentation, or details about system state that led to the error.

404The requested resource was not found in the NoChannel system.

ErrorResponse
Example
```
{
  "name": "ResourceNotFoundError",
  "code": "TEMPLATE_NOT_FOUND",
  "detail": "The configuration template with ID \"payment-stripe\" was not found in the system.",
  "reason": "The template may have been deleted or you may not have permission to access it. Verify the template ID using GET /tenants/cfg/templates."
}
```
Description
Standard error response returned when a request fails due to business logic, authorization, or system errors. Provides structured information for debugging and user-facing error messages.
- namestringrequired
  Example
  ResourceNotFoundError
  Description
  The high-level error category or type name. This is a machine-readable identifier for the class of error (e.g., 'AuthorizationError', 'ResourceNotFoundError', 'ValidationError'). Use this for programmatic error handling.
- codestringrequired
  Example
  TEMPLATE_NOT_FOUND
  Description
  A specific error code identifying the exact error condition. More granular than name, this code can be used for precise error handling and localization. Format is typically uppercase with underscores (e.g., 'TEMPLATE_NOT_FOUND', 'INSUFFICIENT_PERMISSIONS').
- detailstringrequired
  Example
  The configuration template with ID "payment-stripe" was not found in the system.
  Description
  A human-readable description of the error, including context about what went wrong. This message is suitable for display to end users or inclusion in logs. May include specifics like resource IDs or field names.
- reasonstring
  Example
  The template may have been deleted or you may not have permission to access it. Verify the template ID using GET /tenants/cfg/templates.
  Description
  Optional additional context explaining why the error occurred or what action the user should take. May include suggestions for resolution, links to documentation, or details about system state that led to the error.

curl

curl --request GET \
     --url https://api.upstartcommerce.com/v1/tenants/cfg/templates \
     --header 'accept: application/json' \
     --header 'x-upstart-tenant: string'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("x-upstart-tenant", "string");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.upstartcommerce.com/v1/tenants/cfg/templates", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.upstartcommerce.com/v1/tenants/cfg/templates")

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

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request["x-upstart-tenant"] = "string"

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

python

import requests
import json

url = "https://api.upstartcommerce.com/v1/tenants/cfg/templates"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json',
   'x-upstart-tenant': 'string'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// Success-templates returned.
[
  {
    "tenant": "acme-retail",
    "domain": "acme",
    "templateId": "payment-cybersource",
    "name": "Cybersource Payment Gateway Configuration",
    "propertiesDec": {},
    "enabled": true,
    "version": 3,
    "accessControl": {
      "read": true,
      "modify": false
    },
    "audit": {
      "byId": "",
      "by": "",
      "byAnonymous": false,
      "at": "2024-01-15T10:30:00Z",
      "traceId": "550e8400-e29b-41d4-a716-446655440000",
      "serviceName": "tenant-svc",
      "serviceVersion": "1.2.3",
      "byDomain": "example-store",
      "bySubjectType": "USER"
    }
  }
]

400

// The request contained information that the server was unable to process. Appropriate errors are provided in the response body.
{
  "name": "ValidationError",
  "code": "SCHEMA_VALIDATION_FAILED",
  "detail": "Configuration data validation failed: data.apiKey is required but was not provided. Expected string with minimum length 32."
}

401

// The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.
{
  "name": "ResourceNotFoundError",
  "code": "TEMPLATE_NOT_FOUND",
  "detail": "The configuration template with ID \"payment-stripe\" was not found in the system.",
  "reason": "The template may have been deleted or you may not have permission to access it. Verify the template ID using GET /tenants/cfg/templates."
}

404

// The requested resource was not found in the NoChannel system.
{
  "name": "ResourceNotFoundError",
  "code": "TEMPLATE_NOT_FOUND",
  "detail": "The configuration template with ID \"payment-stripe\" was not found in the system.",
  "reason": "The template may have been deleted or you may not have permission to access it. Verify the template ID using GET /tenants/cfg/templates."
}