PactFlow APIs
Mode
Log in
Getting Started
Authentication and Authorization
Requests and Responses
Errors
Pagination
Versioning
Support
SCIM API
PactFlow API
root
-
get
/
audit
-
get
/audit
branch
-
get
/pacticipants/{pacticipantName}/branches
-
get
/pacticipants/{pacticipantName}/branches/{branchName}
-
delete
/pacticipants/{pacticipantName}/branches/{branchName}
can-i-deploy
-
get
/can-i-deploy
consumer-contracts
-
post
/contracts/publish
provider-contracts
-
post
/provider-contracts/provider/{providerName}/publish
bi-directional-contracts
-
get
/contracts/bi-directional/provider/{providerName}/version/{providerVersionNumber}/provider-contract
-
get
/contracts/bi-directional/provider/{providerName}/version/{providerVersionNumber}/provider-contract-verification-results
-
get
/contracts/bi-directional/provider/{providerName}/version/{providerVersionNumber}/consumer-contract
-
get
/contracts/bi-directional/provider/{providerName}/version/{providerVersionNumber}/consumer-contract-verification-results
-
get
/contracts/bi-directional/provider/{providerName}/version/{providerVersionNumber}/cross-contract-verification-results
-
get
/contracts/bi-directional/provider/{providerName}/version/{providerVersionNumber}/consumer/{consumerName}/version/{consumerVersionNumber}/consumer-contract
-
get
/contracts/bi-directional/provider/{providerName}/version/{providerVersionNumber}/consumer/{consumerName}/version/{consumerVersionNumber}/provider-contract
-
get
/contracts/bi-directional/provider/{providerName}/version/{providerVersionNumber}/consumer/{consumerName}/version/{consumerVersionNumber}/provider-contract-verification-results
-
get
/contracts/bi-directional/provider/{providerName}/version/{providerVersionNumber}/consumer/{consumerName}/version/{consumerVersionNumber}/consumer-contract-verification-results
-
get
/contracts/bi-directional/provider/{providerName}/version/{providerVersionNumber}/consumer/{consumerName}/version/{consumerVersionNumber}/cross-contract-verification-results
environment
-
get
/environments
-
post
/environments
-
get
/environments/{environmentId}
-
put
/environments/{environmentId}
-
delete
/environments/{environmentId}
matrix
-
get
/matrix
metric
-
get
/metrics
-
get
/metrics/teams
integration
-
get
/integrations
-
delete
/integrations
-
delete
/integrations/provider/{providerName}/consumer/{consumerName}
-
get
/integrations/team/{teamId}
-
get
/pacticipant/{pacticipantName}/network
label
-
get
/labels
-
get
/pacticipants/{pacticipantName}/labels/{labelName}
-
put
/pacticipants/{pacticipantName}/labels/{labelName}
-
delete
/pacticipants/{pacticipantName}/labels/{labelName}
pacticipant
-
get
/pacticipants
-
post
/pacticipants
-
get
/pacticipants/{pacticipantName}
-
put
/pacticipants/{pacticipantName}
-
delete
/pacticipants/{pacticipantName}
-
patch
/pacticipants/{pacticipantName}
-
get
/pacticipants/{pacticipantName}/main-branch/can-i-merge/badge
-
get
/pacticipants/label/{labelName}
pacticipant-version
-
get
/pacticipants/{pacticipantName}/versions
-
get
/pacticipants/{pacticipantName}/versions/{versionNumber}
-
put
/pacticipants/{pacticipantName}/versions/{versionNumber}
-
get
/pacticipants/{pacticipantName}/latest-version
-
get
/pacticipants/{pacticipantName}/latest-version/{tag}
-
get
/pacticipants/{pacticipantName}/branches/{branchName}/versions
permission
-
get
/admin/permissions
preferences
-
get
/preferences/current-user
-
post
/preferences/current-user
-
get
/preferences/current-user/{userPreference}
-
put
/preferences/current-user/{userPreference}
-
delete
/preferences/current-user/{userPreference}
-
get
/preferences/system
-
post
/preferences/system
-
get
/preferences/system/{systemPreference}
-
put
/preferences/system/{systemPreference}
-
delete
/preferences/system/{systemPreference}
record-deployment
-
get
/pacticipants/{pacticipantName}/versions/{versionNumber}/deployed-versions/environment/{environmentId}
-
post
/pacticipants/{pacticipantName}/versions/{versionNumber}/deployed-versions/environment/{environmentId}
-
get
/environments/{environmentId}/deployed-versions/currently-deployed
record-release
-
get
/pacticipants/{pacticipantName}/versions/{versionNumber}/released-versions/environment/{environmentId}
-
post
/pacticipants/{pacticipantName}/versions/{versionNumber}/released-versions/environment/{environmentId}
-
get
/environments/{environmentId}/released-versions/currently-supported
role
-
get
/admin/roles
-
post
/admin/roles
-
get
/admin/roles/{roleId}
-
put
/admin/roles/{roleId}
-
delete
/admin/roles/{roleId}
-
post
/admin/roles/reset
secret
-
get
/secrets
-
post
/secrets
-
get
/secrets/{secretId}
-
put
/secrets/{secretId}
-
delete
/secrets/{secretId}
team
-
get
/admin/teams
-
post
/admin/teams
-
get
/admin/teams/{teamId}
-
put
/admin/teams/{teamId}
-
delete
/admin/teams/{teamId}
-
get
/admin/teams/{teamId}/users
-
put
/admin/teams/{teamId}/users
-
patch
/admin/teams/{teamId}/users
-
get
/admin/teams/{teamId}/users/{userId}
-
delete
/admin/teams/{teamId}/users/{userId}
token
-
get
/settings/tokens
-
post
/settings/tokens/{tokenId}/regenerate
-
get
/admin/system-accounts/{accountId}/tokens
user
-
get
/user
-
get
/admin/users
-
post
/admin/users
-
post
/admin/users/invite-users
-
get
/admin/users/{userId}
-
put
/admin/users/{userId}
-
delete
/admin/users/{userId}
-
put
/admin/users/{userId}/roles
-
put
/admin/users/{userId}/roles/{roleId}
-
delete
/admin/users/{userId}/roles/{roleId}
-
post
/admin/system-accounts
verifiable-pacts
-
post
/pacts/provider/{providerName}/for-verification
webhook
-
get
/webhooks
-
post
/webhooks
-
post
/webhooks/execute
-
get
/webhooks/{webhookId}
-
put
/webhooks/{webhookId}
-
delete
/webhooks/{webhookId}
-
post
/webhooks/{webhookId}/execute
Schemas
-
Action
-
AuditEvents
-
AuthFailureEvent
-
CustomEvent
-
CustomPayload
-
HttpAuditEvent
-
HttpAuditResponse
-
HttpRequestPayload
-
Branch
-
Branches
-
PublishConsumerContract
-
PublishedConsumerContract
-
BiDirectionalConsumerContract
-
BiDirectionalConsumerContractVerificationResults
-
BiDirectionalCrossContractVerificationResults
-
BiDirectionalProviderContract
-
BiDirectionalProviderContractVerificationResults
-
ConsumerContract
-
ConsumerContractVerificationResults
-
CrossContractVerificationResults
-
CrossContractVerificationResultsInConsumerContract
-
CrossContractVerificationResultsInProviderContract
-
ProviderContractVerificationResultsInConsumerContract
-
ProviderContractVerificationResultsInProviderContract
-
EmbeddedBranchVersion
-
EmbeddedEnvironment
-
EmbeddedLabel
-
EmbeddedLink
-
EmbeddedPacticipant
-
EmbeddedTag
-
EmbeddedTeam
-
EmbeddedUser
-
EmbeddedVersion
-
EmbeddedWebhook
-
CreateUpdateEnvironment
-
Environment
-
Environments
-
Integration
-
Integrations
-
pacticipantIntegrations
-
Label
-
Labels
-
PacticipantLabel
-
LegacyValidationErrors
-
Matrix
-
MatrixPacticipant
-
MatrixPacticipantVersion
-
Metrics
-
TeamMetrics
-
Network
-
Notice
-
Notices
-
Overview
-
CreatePacticipant
-
Pacticipant
-
Pacticipants
-
UpdatePacticipant
-
CreateUpdatePacticipantVersion
-
PacticipantVersion
-
PacticipantVersionInCollection
-
PacticipantVersionWithoutLinks
-
PacticipantVersions
-
Page
-
Permission
-
Permissions
-
CreateUpdatePreference
-
CreateUpdatePreferences
-
Preference
-
Preferences
-
ProblemJson
-
ProviderContract
-
PublishProviderContract
-
PublishedProviderContract
-
ProviderContractAndPactVerificationResults
-
DeployedVersion
-
DeployedVersionsForEnvironment
-
DeployedVersionsForVersionAndEnvironment
-
EmbeddedDeployedVersion
-
RecordDeployment
-
EmbeddedReleasedVersion
-
ReleasedVersion
-
ReleasedVersionsForEnvironment
-
ReleasedVersionsForVersionAndEnvironment
-
CreateUpdateRole
-
Role
-
Roles
-
Root
-
CreateSecret
-
Secret
-
Secrets
-
UpdateSecret
-
SelfVerificationResult
-
Tag
-
CreateUpdateTeam
-
CreatedTeam
-
PatchUpdateTeamUsers
-
Team
-
TeamInCollection
-
Teams
-
EmbeddedTeamUser
-
TeamUser
-
TeamUsers
-
Token
-
Tokens
-
TriggeredWebhooks
-
CreateSystemAccount
-
CreateUser
-
InviteUsers
-
InvitedUsers
-
SetUserRoles
-
UpdateUser
-
User
-
Users
-
UserRole
-
UserTeam
-
ConsumerVersionSelector
-
VerifiablePact
-
VerifiablePactQuery
-
VerifiablePacts
-
VerificationStatus
-
CreateWebhook
-
TestUnsavedWebhook
-
UnsavedWebhookExecutionResult
-
UpdateWebhook
-
Webhook
-
WebhookExecutionResult
-
Webhooks
Routing
Download API