Netlify's API

Netlify's API definition

 0.11.4

[ Base URL: api.netlify.com/api/v1 ]

/swagger.json

Schemes

accessToken

POST/oauth/tickets/{ticket_id}/exchange

exchangeTicket

accountMembership

GET/accounts

listAccountsForUser

POST/accounts

createAccount

GET/accounts/{account_id}

getAccount

PUT/accounts/{account_id}

updateAccount

DELETE/accounts/{account_id}

cancelAccount

accountType

GET/accounts/types

listAccountTypesForUser

asset

GET/sites/{site_id}/assets

listSiteAssets

POST/sites/{site_id}/assets

createSiteAsset

GET/sites/{site_id}/assets/{asset_id}

getSiteAssetInfo

PUT/sites/{site_id}/assets/{asset_id}

updateSiteAsset

DELETE/sites/{site_id}/assets/{asset_id}

deleteSiteAsset

assetPublicSignature

GET/sites/{site_id}/assets/{asset_id}/public_signature

getSiteAssetPublicSignature

auditLog

GET/accounts/{account_id}/audit

listAccountAuditEvents

build

GET/sites/{site_id}/builds

listSiteBuilds

POST/sites/{site_id}/builds

createSiteBuild

GET/builds/{build_id}

getSiteBuild

POST/builds/{build_id}/start

notifyBuildStart

buildHook

GET/sites/{site_id}/build_hooks

listSiteBuildHooks

POST/sites/{site_id}/build_hooks

createSiteBuildHook

GET/sites/{site_id}/build_hooks/{id}

getSiteBuildHook

PUT/sites/{site_id}/build_hooks/{id}

updateSiteBuildHook

DELETE/sites/{site_id}/build_hooks/{id}

deleteSiteBuildHook

buildLogMsg

POST/builds/{build_id}/log

updateSiteBuildLog

deploy

GET/sites/{site_id}/deploys

listSiteDeploys

POST/sites/{site_id}/deploys

createSiteDeploy

GET/sites/{site_id}/deploys/{deploy_id}

getSiteDeploy

PUT/sites/{site_id}/deploys/{deploy_id}

updateSiteDeploy

POST/sites/{site_id}/deploys/{deploy_id}/restore

restoreSiteDeploy

GET/deploys/{deploy_id}

getDeploy

POST/deploys/{deploy_id}/lock

lockDeploy

POST/deploys/{deploy_id}/unlock

unlockDeploy

deployedBranch

GET/sites/{site_id}/deployed-branches

listSiteDeployedBranches

deployKey

GET/deploy_keys

listDeployKeys

POST/deploy_keys

createDeployKey

GET/deploy_keys/{key_id}

getDeployKey

DELETE/deploy_keys/{key_id}

deleteDeployKey

dnsZone

GET/sites/{site_id}/dns

getDNSForSite

PUT/sites/{site_id}/dns

configureDNSForSite

file

GET/sites/{site_id}/files

listSiteFiles

GET/sites/{site_id}/files/{file_path}

getSiteFileByPathName

PUT/deploys/{deploy_id}/files/{path}

uploadDeployFile

form

GET/sites/{site_id}/forms

listSiteForms

GET/forms

listForms

function

PUT/deploys/{deploy_id}/functions/{name}

uploadDeployFunction

hook

GET/hooks

listHooksBySiteId

POST/hooks

createHookBySiteId

GET/hooks/{hook_id}

getHook

PUT/hooks/{hook_id}

updateHook

DELETE/hooks/{hook_id}

deleteHookBySiteId

POST/hooks/{hook_id}/enable

enableHook

hookType

GET/hooks/types

listHookTypes

member

GET/{account_slug}/members

listMembersForAccount

POST/{account_slug}/members

addMemberToAccount

metadata

GET/sites/{site_id}/metadata

getSiteMetadata

PUT/sites/{site_id}/metadata

updateSiteMetadata

paymentMethod

GET/billing/payment_methods

listPaymentMethodsForUser

service

GET/services/

getServices

GET/services/{addonName}

showService

GET/services/{addonName}/manifest

showServiceManifest

serviceInstance

POST/sites/{site_id}/services/{addon}/instances

createServiceInstance

GET/sites/{site_id}/services/{addon}/instances

showServiceInstance

PUT/sites/{site_id}/services/{addon}/instances

updateServiceInstance

DELETE/sites/{site_id}/services/{addon}/instances

deleteServiceInstance

site

GET/sites

listSites

POST/sites

createSite

GET/sites/{site_id}

getSite

PATCH/sites/{site_id}

updateSite

DELETE/sites/{site_id}

deleteSite

POST/{account_slug}/sites

createSiteInTeam

GET/{account_slug}/sites

listSitesForAccount

sniCertificate

POST/sites/{site_id}/ssl

provisionSiteTLSCertificate

GET/sites/{site_id}/ssl

showSiteTLSCertificate

snippet

GET/sites/{site_id}/snippets

listSiteSnippets

POST/sites/{site_id}/snippets

createSiteSnippet

GET/sites/{site_id}/snippets/{snippet_id}

getSiteSnippet

PUT/sites/{site_id}/snippets/{snippet_id}

updateSiteSnippet

DELETE/sites/{site_id}/snippets/{snippet_id}

deleteSiteSnippet

splitTest

POST/site/{site_id}/traffic_splits

createSplitTest

GET/site/{site_id}/traffic_splits

getSplitTests

PUT/site/{site_id}/traffic_splits/{split_test_id}

updateSplitTest

GET/site/{site_id}/traffic_splits/{split_test_id}

getSplitTest

POST/site/{site_id}/traffic_splits/{split_test_id}/publish

enableSplitTest

POST/site/{site_id}/traffic_splits/{split_test_id}/unpublish

disableSplitTest

submission

GET/sites/{site_id}/submissions

listSiteSubmissions

GET/forms/{form_id}/submissions

listFormSubmissions

GET/submissions/{submission_id}

listFormSubmission

DELETE/submissions/{submission_id}

deleteSubmission

ticket

POST/oauth/tickets

createTicket

GET/oauth/tickets/{ticket_id}

showTicket

user

GET/user

getCurrentUser

Models

splitTestSetup

splitTests