Skip to navigation
API ReferenceConnections

Delete Connection

Deletes a connection.

🚧 Deleting a connection that is referenced by fieldsets, syncs, bulk syncs, or schedules returns 422 connection in use unless you pass force=true. With force=true, the API deletes those dependent resources before removing the connection.

Authentication

AuthorizationBasic

This is the Polytomic deployment key (on-premises only)

OR
AuthorizationBearer
This is the Polytomic API key

Path parameters

idstringRequiredformat: "uuid"
Connection ID

Headers

X-Polytomic-VersionstringRequired

Query parameters

forcebooleanOptional
Delete the connection with the models and syncs that depend on it.

Response

No Content

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
500
Internal Server Error