---
title: "Attach"
method: POST
path: "/api/py/instance-sources"
tags: ["instance-sources"]
---

# Attach

`POST /api/py/instance-sources`

## Request

- Base URL: `https://api.getauctor.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.getauctor.com/api/py/instance-sources`
- Auth: none declared

## Request body

- union
  - InstanceSourceCreateRequest
    - `source_type` 'successfactors_instance', required
    - `instance_id` string, uuid, required
    - `payload` SuccessFactorsPayload, required
      - `kind` 'saml_bearer', required
      - `api_server_url` string, required
      - `company_id` string, required
      - `user_id` string, required
      - `client_id` string, required
      - `private_key` string, required
      - `certificate` string, required
      - `environment` 'production' | 'sandbox' | 'scratch' | 'unknown', nullable
  - SapCloudAlmCreateRequest
    - `source_type` 'sap_cloud_alm_tenant', required
    - `instance_id` string, uuid, required
    - `payload` SapCloudAlmPayload, required
      - `kind` 'client_credentials', required
      - `api_url` string, required
      - `token_url` string, required
      - `client_id` string, required
      - `client_secret` string, required
      - `environment` 'production' | 'sandbox' | 'scratch' | 'unknown', nullable
  - StaticCredentialsCreateRequest
    - `source_type` 'static_credentials', required
    - `instance_id` string, uuid, required
    - `payload` StaticCredentialsConfig, required
      - `version` 1, required
      - `secrets` object, required
      - `services` StaticCredentialsService[], required
        - `id` string, required
        - `host` string, required
        - `inject` HeaderInjection
          - `headers` object, required
        - `substitute` SecretSubstitution[], nullable
          - `secret` string, required
          - `in` string[], required

## Response `200`

Successful Response

- union
  - SapiensDeliveryConnectorsSuccessfactorsPersistenceAttachResult
    - `id` string, uuid, required
    - `source_type` string, required
    - `delivery_instance_id` string, uuid, required
    - `organization_id` string, required
    - `credential_kind` string, required
    - `external_instance_url` string, required
    - `external_org_id` string, required
    - `subject_external_user_id` string, required
    - `environment` string, nullable, required
    - `status` string, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
  - SapiensDeliveryConnectorsSapCloudAlmPersistenceAttachResult
    - `id` string, uuid, required
    - `source_type` string, required
    - `delivery_instance_id` string, uuid, required
    - `organization_id` string, required
    - `credential_kind` string, required
    - `external_instance_url` string, required
    - `external_account_url` string, required
    - `external_org_id` string, required
    - `subject_external_user_id` string, required
    - `environment` string, nullable, required
    - `status` string, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
  - StaticCredentialsAttachResult
    - `id` string, uuid, required
    - `source_type` string, required
    - `delivery_instance_id` string, uuid, required
    - `organization_id` string, required
    - `credential_kind` string, required
    - `status` string, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `409`: Conflict
- `422`: Validation Error
- `500`: Internal Server Error

## Changes

- **2026-10-14** `5c801d686c91`: 3 info
  - added `static_credentials` mapping keys to the request discriminator
  - added `#/components/schemas/StaticCredentialsCreateRequest` to the request body `oneOf` list
  - added `#/components/schemas/StaticCredentialsAttachResult` to the response body `anyOf` list for the response status `200`
- **2026-10-07** `5e1e3d888189`: 14 breaking, 3 warning, 3 info
  - the request's body type changed from `object` to no type
  - the response's body type changed from `object` to no type for status `200`
  - removed the required property `created_at` from the response with the `200` status
  - removed the required property `credential_kind` from the response with the `200` status
  - …16 more
- **2026-10-02** `c547e282a5ec`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/getauctor/apis/getauctor-api/changes/api/py/instance-sources/post.md)

---

[API](https://skmtc.dev/getauctor/apis/getauctor-api.md) - [All operations](https://skmtc.dev/getauctor/apis/getauctor-api/llms.txt) - [OpenAPI document](https://skmtc.dev/getauctor/apis/getauctor-api/revisions/be39c59c13f6?raw)