How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Socotra

Socotra Config API

The Config API from Socotra — 19 operation(s) for config.

Documentation Provider Profile APIs.io OpenAPI GitHub

Socotra Config API is one of 18 APIs that Socotra publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Config. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 20 operations across 19 paths, and defines 96 schemas. It is described by OpenAPI 3.2.0, at version v0.

Requests are made against a single base URL, /.

20 operations 19 paths 96 schemas 9 GET1 PATCH10 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v0
Base URL
https://api.sandbox.socotra.com
Terms of Service
View terms
Resource Areas
1

Paths & Operations 20

Across 19 paths, the API surfaces 20 operations — 9 GET, 1 PATCH, 10 POST. Each is listed below with its method, path, parameters, and response codes.

Config 20
POST
/config/validateConfig
validateConfig body → 200
POST
/config/{tenantLocator}/tenantEvents
scheduleTenantEvents 1 param body → 200
GET
/config/{tenantLocator}/moratoriums
fetchMoratoriums 1 param → 200
POST
/config/{tenantLocator}/moratoriums
deployMoratoriums 1 param body → 200
POST
/config/formatConfig
Converts a configuration's property casing to match requirements
formatConfig body → 200
POST
/config/{tenantLocator}/developer/build
buildBundle 1 param body → 200
POST
/config/{tenantLocator}/deployments/validate
validateConfigZip 1 param body → 200
POST
/config/{tenantLocator}/deployments/deploy
deployConfigZip 2 params body → 200
POST
/config/{tenantLocator}/deployments/cloneTest
cloneConfigToTest 3 params → 200
POST
/config/{tenantLocator}/deployments/cloneProduction
cloneConfigToProduction 3 params → 200
POST
/config/createTenant
createTenant 2 params body → 200
PATCH
/config/{tenantLocator}/deployments/versions/{staticVersionLocator}/retire
retireConfigVersion 2 params → 200
GET
/config/events
fetchConfigEvents → 200
GET
/config/{tenantLocator}/developer/download
downloadBundle 1 param → 200
GET
/config/{tenantLocator}/deployments
getDeployedConfigMetadata 1 param → 200
GET
/config/{tenantLocator}/deployments/download
downloadCurrentConfiguration 1 param → 200
GET
/config/{tenantLocator}/deployments/download/{version}
downloadConfigurationVersion 3 params → 200
GET
/config/{tenantLocator}/deployments/diff
getPartialDeployDifference 2 params → 200
GET
/config/{tenantLocator}/deployments/datamodel
fetchConfigDefinition 2 params → 200
GET
/config/{tenantLocator}/deployments/datamodel/{version}
fetchConfigDefinitionForAVersion 4 params → 200

Schemas 96

The contract defines 96 schemas that model the data the API accepts and returns. The most detailed are ConfigurationRef (77 properties), ProductRef (33 properties), PropertyRef (17 properties), AccountRef (11 properties). Each schema is shown below with its type and property counts.

ScheduleTenantEventRequest
object
4 properties 4 required
AutomationPluginActionRef
object
3 properties
PropertyConstraint
object
3 properties 3 required
CoverageTermRef
object
5 properties 1 required
ColumnRef
object
2 properties 2 required
ReversalTypeRef
object
1 property 1 required
ExcessCreditPlanRef
object
7 properties 7 required
InstallmentPlanRef
object
8 properties 6 required
ConstraintColumnRef
object
2 properties 2 required
WorkManagementRef
object
3 properties
RangeTableRef
object
4 properties 3 required
ContactRef
object
4 properties 1 required
TableRef
object
2 properties 2 required
MoratoriumProductRuleRef
object
4 properties 3 required
ResourcesRef
object
2 properties 2 required
BillingHoldScopeRef
object
5 properties 4 required
UserAssociationRoleRef
object
3 properties
IntentPlan
object
3 properties 2 required
AvailabilityRef
object
Specifies availability. At least one of availableAfter, retireAfter, retire, removeOnRenewalAfter, or removeOnRenewal must be set.
7 properties 2 required
TenantDeploymentResult
object
4 properties 4 required
UnderwritingFlagRef
object
3 properties
ConsolidatedDocumentConfigRef
object
4 properties 1 required
ScheduleRef
object
5 properties 2 required
DeploymentServiceEventTypeDefinitions
object
1 property 1 required
MoratoriumRef
object
10 properties 6 required
MoratoriumRuleRef
object
3 properties 3 required
BootstrapRef
object
1 property 1 required
Values
object
7 properties 7 required
ProductRef
object
33 properties
DeployedConfigMetadata
object
4 properties 3 required
DocumentConfigRef
object
11 properties 7 required
DataAccessControlFieldRef
object
1 property 1 required
MapDifference
object
3 properties 3 required
TenantCustomEventRef
object
3 properties 2 required
StreamingResponseBody
object
ConfigBuilderResult
object
3 properties 3 required
ConfigurationRef
object
77 properties 3 required
JurisdictionRef
object
1 property
NegativeInvoiceHandlingRef
object
6 properties 6 required
ConditionValueRef
object
2 properties 2 required
LossRef
object
5 properties 2 required
ChargeRef
object
5 properties 4 required
DisplayHintsRef
object
2 properties
RegionRef
object
2 properties
CoverageTermOptionRef
object
4 properties 1 required
BootstrapResult
object
2 properties 2 required
DelinquencyEventConfiguration
object
2 properties 2 required
ProducerAppointmentRef
object
4 properties 3 required
EventScheduleRef
object
5 properties 1 required
DataAccessControlRef
object
4 properties 4 required
DataTypeRef
object
5 properties 1 required
InstallmentGroupingDetails
object
2 properties 2 required
PrimitivePropertyRef
object
1 property 1 required
BillingPlanRef
object
2 properties 1 required
DisbursementRef
object
6 properties 1 required
ResourceInstanceRef
object
2 properties 2 required
PaymentRef
object
7 properties 5 required
SecretRef
object
1 property 1 required
ResourceGroupRef
object
2 properties 2 required
ClaimRef
object
3 properties 1 required
PolicyHoldScopeRef
object
4 properties 3 required
RetryPlanRef
object
2 properties 2 required
TaskTypeRef
object
4 properties 2 required
AccountRef
object
11 properties 1 required
ConsolidatedPageNumberingRef
object
4 properties 4 required
TenantEventScheduleRef
object
3 properties
EventCadenceRef
object
3 properties 2 required
InvoicingPlanRef
object
5 properties 4 required
FnolRef
object
7 properties 1 required
ProducerRef
object
5 properties 3 required
DeploymentCloneResponse
object
3 properties 3 required
ExternalNumberingPlanRef
object
2 properties 1 required
AssistantRef
object
2 properties
AuxDataSettingsRef
object
2 properties 1 required
DeploymentMetadata
object
6 properties 5 required
DocumentMarginRef
object
4 properties
NumberingPlanRef
object
8 properties 6 required
AutoRenewalPlanRef
object
6 properties 1 required
CustomEventRef
object
2 properties 1 required
PropertyRef
object
17 properties
ScheduleTenantEventsRequest
object
1 property 1 required
MoratoriumEvents
object
4 properties
TemplateSnippetConfigRef
object
2 properties 1 required
ProducerCodeRef
object
7 properties 5 required
ProducerManagementRef
object
5 properties 5 required
MoratoriumEventData
object
3 properties 3 required
RestrictedDataRef
object
3 properties 3 required
ProducerLicenseRef
object
4 properties 3 required
ElementRef
object
11 properties
ConstraintTableRef
object
2 properties 2 required
DelinquencyPlanRef
object
6 properties 1 required
MoratoriumPolicyMatchCriteriaRef
object
2 properties 2 required
ShortfallTolerancePlanRef
object
1 property 1 required
TransactionTypeRef
object
4 properties 2 required
SecretKeyRef
object
2 properties 2 required
AutomationPluginRef
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

socotra-config-api-openapi.yml Raw ↑

Other APIs Socotra publishes across the network.

Socotra Auth API
AE Profile APIs.io
Socotra Auxdata API
AE Profile APIs.io
Socotra Billing API
AE Profile APIs.io
Socotra Business Stats API
AE Profile APIs.io
Socotra Claim API
AE Profile APIs.io
Socotra Compliance API
AE Profile APIs.io
Socotra Contact API
AE Profile APIs.io
Socotra Document API
AE Profile APIs.io
Socotra Event API
AE Profile APIs.io
Socotra Migration API
AE Profile APIs.io
Socotra Payment Execution API
AE Profile APIs.io
Socotra Plugin API
AE Profile APIs.io
#Config
← Back to S APIs
API Details
ID
socotra:socotra-config-api
Base URL
https://api.sandbox.socotra.com
Docs
https://docs.socotra.com/docs/api
Provider
Socotra
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=socotra-config-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/socotra-config-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Socotra Config API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.