Netlify
Documentation Powered by ReDoc

Netlify's API documentation (2.2.0)

Download OpenAPI specification:Download

Terms of Service

Netlify is a hosting service for the programmable web. It understands your documents and provides an API to handle atomic deploys of websites, manage form submissions, inject JavaScript snippets, and much more. This is a REST-style API that uses JSON for serialization and OAuth 2 for authentication.

This document is an OpenAPI reference for the Netlify API that you can explore. For more detailed instructions for common uses, please visit the online documentation. Visit our Community forum to join the conversation about understanding and using Netlify’s API.

Additionally, we have two API clients for your convenience:

Online documentation

Authentication

netlifyAuth

Security Scheme Type OAuth2
implicit OAuth Flow
Authorization URL: https://app.netlify.com/authorize
Scopes:

    Ticket

    createTicket

    Authorizations:
    netlifyAuth
    query Parameters
    client_id
    required
    string

    Responses

    201

    ok

    default

    error

    post /oauth/tickets
    https://api.netlify.com/api/v1/oauth/tickets

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "client_id": "string",
    • "authorized": true,
    • "created_at": "string"
    }

    showTicket

    Authorizations:
    netlifyAuth
    path Parameters
    ticket_id
    required
    string

    Responses

    200

    ok

    default

    error

    get /oauth/tickets/{ticket_id}
    https://api.netlify.com/api/v1/oauth/tickets/{ticket_id}

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "client_id": "string",
    • "authorized": true,
    • "created_at": "string"
    }

    Access token

    exchangeTicket

    Authorizations:
    netlifyAuth
    path Parameters
    ticket_id
    required
    string

    Responses

    201

    ok

    default

    error

    post /oauth/tickets/{ticket_id}/exchange
    https://api.netlify.com/api/v1/oauth/tickets/{ticket_id}/exchange

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "access_token": "string",
    • "user_id": "string",
    • "user_email": "string",
    • "created_at": "string"
    }

    User

    getCurrentUser

    Authorizations:
    netlifyAuth

    Responses

    200

    OK

    default

    error

    get /user
    https://api.netlify.com/api/v1/user

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    [
    • {
      }
    ]

    Accounts

    listAccountsForUser

    Authorizations:
    netlifyAuth

    Responses

    200

    OK

    default

    error

    get /accounts
    https://api.netlify.com/api/v1/accounts

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    [
    • {
      }
    ]

    createAccount

    Authorizations:
    netlifyAuth
    Request Body schema: application/json
    name
    required
    string
    type_id
    required
    string
    payment_method_id
    string
    period
    string
    Enum: "monthly" "yearly"
    extra_seats_block
    integer

    Responses

    201

    Created

    default

    error

    post /accounts
    https://api.netlify.com/api/v1/accounts

    Request samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "name": "string",
    • "type_id": "string",
    • "payment_method_id": "string",
    • "period": "monthly",
    • "extra_seats_block": 0
    }

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "name": "string",
    • "slug": "string",
    • "type": "string",
    • "capabilities":
      {
      },
    • "billing_name": "string",
    • "billing_email": "string",
    • "billing_details": "string",
    • "billing_period": "string",
    • "payment_method_id": "string",
    • "type_name": "string",
    • "type_id": "string",
    • "owner_ids":
      [
      ],
    • "roles_allowed":
      [
      ],
    • "created_at": "string",
    • "updated_at": "string"
    }

    getAccount

    Authorizations:
    netlifyAuth
    path Parameters
    account_id
    required
    string

    Responses

    200

    OK

    default

    error

    get /accounts/{account_id}
    https://api.netlify.com/api/v1/accounts/{account_id}

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    [
    • {
      }
    ]

    updateAccount

    Authorizations:
    netlifyAuth
    path Parameters
    account_id
    required
    string
    Request Body schema: application/json
    name
    string
    slug
    string
    type_id
    string
    extra_seats_block
    integer
    billing_name
    string
    billing_email
    string
    billing_details
    string

    Responses

    200

    OK

    default

    error

    put /accounts/{account_id}
    https://api.netlify.com/api/v1/accounts/{account_id}

    Request samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "name": "string",
    • "slug": "string",
    • "type_id": "string",
    • "extra_seats_block": 0,
    • "billing_name": "string",
    • "billing_email": "string",
    • "billing_details": "string"
    }

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "name": "string",
    • "slug": "string",
    • "type": "string",
    • "capabilities":
      {
      },
    • "billing_name": "string",
    • "billing_email": "string",
    • "billing_details": "string",
    • "billing_period": "string",
    • "payment_method_id": "string",
    • "type_name": "string",
    • "type_id": "string",
    • "owner_ids":
      [
      ],
    • "roles_allowed":
      [
      ],
    • "created_at": "string",
    • "updated_at": "string"
    }

    cancelAccount

    Authorizations:
    netlifyAuth
    path Parameters
    account_id
    required
    string

    Responses

    204

    Not Content

    default

    error

    delete /accounts/{account_id}
    https://api.netlify.com/api/v1/accounts/{account_id}

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "code": 0,
    • "message": "string"
    }

    Member

    listMembersForAccount

    Authorizations:
    netlifyAuth
    path Parameters
    account_slug
    required
    string

    Responses

    200

    OK

    default

    error

    get /{account_slug}/members
    https://api.netlify.com/api/v1/{account_slug}/members

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    [
    • {
      }
    ]

    addMemberToAccount

    Authorizations:
    netlifyAuth
    path Parameters
    account_slug
    required
    string
    query Parameters
    email
    required
    string
    role
    string
    Enum: "Owner" "Collaborator" "Controller"

    Responses

    200

    OK

    default

    error

    post /{account_slug}/members
    https://api.netlify.com/api/v1/{account_slug}/members

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    [
    • {
      }
    ]

    Access type

    listAccountTypesForUser

    Authorizations:
    netlifyAuth

    Responses

    200

    OK

    default

    error

    get /accounts/types
    https://api.netlify.com/api/v1/accounts/types

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    [
    • {
      }
    ]

    Payment method

    listPaymentMethodsForUser

    Authorizations:
    netlifyAuth

    Responses

    200

    OK

    default

    error

    get /billing/payment_methods
    https://api.netlify.com/api/v1/billing/payment_methods

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    [
    • {
      }
    ]

    Audit log

    listAccountAuditEvents

    Authorizations:
    netlifyAuth
    path Parameters
    account_id
    required
    string
    query Parameters
    query
    string
    log_type
    string
    page
    integer <int32>
    per_page
    integer <int32>

    Responses

    200

    OK

    default

    error

    get /accounts/{account_id}/audit
    https://api.netlify.com/api/v1/accounts/{account_id}/audit

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    [
    • {
      }
    ]

    Site

    listSites

    Authorizations:
    netlifyAuth
    query Parameters
    name
    string
    filter
    string
    Enum: "all" "owner" "guest"
    page
    integer <int32>
    per_page
    integer <int32>

    Responses

    200

    OK

    default

    error

    get /sites
    https://api.netlify.com/api/v1/sites

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    [
    • {
      }
    ]

    createSite

    Authorizations:
    netlifyAuth
    query Parameters
    configure_dns
    boolean
    Request Body schema: application/json
    id
    string
    state
    string
    plan
    string
    name
    string
    custom_domain
    string
    domain_aliases
    Array of strings
    password
    string
    notification_email
    string
    url
    string
    ssl_url
    string
    admin_url
    string
    screenshot_url
    string
    created_at
    string <dateTime>
    updated_at
    string <dateTime>
    user_id
    string
    session_id
    string
    ssl
    boolean
    force_ssl
    boolean
    managed_dns
    boolean
    deploy_url
    string
    published_deploy
    object (deploy)
    account_name
    string
    account_slug
    string
    git_provider
    string
    deploy_hook
    string
    capabilities
    object
    processing_settings
    object
    build_settings
    object (repoInfo)
    id_domain
    string
    default_hooks_data
    object
    build_image
    string
    prerender
    string
    repo
    object (repoInfo)

    Responses

    201

    Created

    default

    error

    post /sites
    https://api.netlify.com/api/v1/sites

    Request samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "state": "string",
    • "plan": "string",
    • "name": "string",
    • "custom_domain": "string",
    • "domain_aliases":
      [
      ],
    • "password": "string",
    • "notification_email": "string",
    • "url": "string",
    • "ssl_url": "string",
    • "admin_url": "string",
    • "screenshot_url": "string",
    • "created_at": "string",
    • "updated_at": "string",
    • "user_id": "string",
    • "session_id": "string",
    • "ssl": true,
    • "force_ssl": true,
    • "managed_dns": true,
    • "deploy_url": "string",
    • "published_deploy":
      {
      },
    • "account_name": "string",
    • "account_slug": "string",
    • "git_provider": "string",
    • "deploy_hook": "string",
    • "capabilities":
      {
      },
    • "processing_settings":
      {
      },
    • "build_settings":
      {
      },
    • "id_domain": "string",
    • "default_hooks_data":
      {
      },
    • "build_image": "string",
    • "prerender": "string",
    • "repo":
      {
      }
    }

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "state": "string",
    • "plan": "string",
    • "name": "string",
    • "custom_domain": "string",
    • "domain_aliases":
      [
      ],
    • "password": "string",
    • "notification_email": "string",
    • "url": "string",
    • "ssl_url": "string",
    • "admin_url": "string",
    • "screenshot_url": "string",
    • "created_at": "string",
    • "updated_at": "string",
    • "user_id": "string",
    • "session_id": "string",
    • "ssl": true,
    • "force_ssl": true,
    • "managed_dns": true,
    • "deploy_url": "string",
    • "published_deploy":
      {
      },
    • "account_name": "string",
    • "account_slug": "string",
    • "git_provider": "string",
    • "deploy_hook": "string",
    • "capabilities":
      {
      },
    • "processing_settings":
      {
      },
    • "build_settings":
      {
      },
    • "id_domain": "string",
    • "default_hooks_data":
      {
      },
    • "build_image": "string",
    • "prerender": "string"
    }

    getSite

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string

    Responses

    200

    OK

    default

    error

    get /sites/{site_id}
    https://api.netlify.com/api/v1/sites/{site_id}

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "state": "string",
    • "plan": "string",
    • "name": "string",
    • "custom_domain": "string",
    • "domain_aliases":
      [
      ],
    • "password": "string",
    • "notification_email": "string",
    • "url": "string",
    • "ssl_url": "string",
    • "admin_url": "string",
    • "screenshot_url": "string",
    • "created_at": "string",
    • "updated_at": "string",
    • "user_id": "string",
    • "session_id": "string",
    • "ssl": true,
    • "force_ssl": true,
    • "managed_dns": true,
    • "deploy_url": "string",
    • "published_deploy":
      {
      },
    • "account_name": "string",
    • "account_slug": "string",
    • "git_provider": "string",
    • "deploy_hook": "string",
    • "capabilities":
      {
      },
    • "processing_settings":
      {
      },
    • "build_settings":
      {
      },
    • "id_domain": "string",
    • "default_hooks_data":
      {
      },
    • "build_image": "string",
    • "prerender": "string"
    }

    updateSite

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string
    Request Body schema: application/json
    id
    string
    state
    string
    plan
    string
    name
    string
    custom_domain
    string
    domain_aliases
    Array of strings
    password
    string
    notification_email
    string
    url
    string
    ssl_url
    string
    admin_url
    string
    screenshot_url
    string
    created_at
    string <dateTime>
    updated_at
    string <dateTime>
    user_id
    string
    session_id
    string
    ssl
    boolean
    force_ssl
    boolean
    managed_dns
    boolean
    deploy_url
    string
    published_deploy
    object (deploy)
    account_name
    string
    account_slug
    string
    git_provider
    string
    deploy_hook
    string
    capabilities
    object
    processing_settings
    object
    build_settings
    object (repoInfo)
    id_domain
    string
    default_hooks_data
    object
    build_image
    string
    prerender
    string
    repo
    object (repoInfo)

    Responses

    200

    OK

    default

    error

    patch /sites/{site_id}
    https://api.netlify.com/api/v1/sites/{site_id}

    Request samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "state": "string",
    • "plan": "string",
    • "name": "string",
    • "custom_domain": "string",
    • "domain_aliases":
      [
      ],
    • "password": "string",
    • "notification_email": "string",
    • "url": "string",
    • "ssl_url": "string",
    • "admin_url": "string",
    • "screenshot_url": "string",
    • "created_at": "string",
    • "updated_at": "string",
    • "user_id": "string",
    • "session_id": "string",
    • "ssl": true,
    • "force_ssl": true,
    • "managed_dns": true,
    • "deploy_url": "string",
    • "published_deploy":
      {
      },
    • "account_name": "string",
    • "account_slug": "string",
    • "git_provider": "string",
    • "deploy_hook": "string",
    • "capabilities":
      {
      },
    • "processing_settings":
      {
      },
    • "build_settings":
      {
      },
    • "id_domain": "string",
    • "default_hooks_data":
      {
      },
    • "build_image": "string",
    • "prerender": "string",
    • "repo":
      {
      }
    }

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "state": "string",
    • "plan": "string",
    • "name": "string",
    • "custom_domain": "string",
    • "domain_aliases":
      [
      ],
    • "password": "string",
    • "notification_email": "string",
    • "url": "string",
    • "ssl_url": "string",
    • "admin_url": "string",
    • "screenshot_url": "string",
    • "created_at": "string",
    • "updated_at": "string",
    • "user_id": "string",
    • "session_id": "string",
    • "ssl": true,
    • "force_ssl": true,
    • "managed_dns": true,
    • "deploy_url": "string",
    • "published_deploy":
      {
      },
    • "account_name": "string",
    • "account_slug": "string",
    • "git_provider": "string",
    • "deploy_hook": "string",
    • "capabilities":
      {
      },
    • "processing_settings":
      {
      },
    • "build_settings":
      {
      },
    • "id_domain": "string",
    • "default_hooks_data":
      {
      },
    • "build_image": "string",
    • "prerender": "string"
    }

    deleteSite

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string

    Responses

    204

    Deleted

    default

    error

    delete /sites/{site_id}
    https://api.netlify.com/api/v1/sites/{site_id}

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "code": 0,
    • "message": "string"
    }

    unlinkSiteRepo

    [Beta] Unlinks the repo from the site.

    This action will also:

    • Delete associated deploy keys
    • Delete outgoing webhooks for the repo
    • Delete the site's build hooks
    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string

    Responses

    200

    OK

    404

    Site not found

    put /sites/{site_id}/unlink_repo
    https://api.netlify.com/api/v1/sites/{site_id}/unlink_repo

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "state": "string",
    • "plan": "string",
    • "name": "string",
    • "custom_domain": "string",
    • "domain_aliases":
      [
      ],
    • "password": "string",
    • "notification_email": "string",
    • "url": "string",
    • "ssl_url": "string",
    • "admin_url": "string",
    • "screenshot_url": "string",
    • "created_at": "string",
    • "updated_at": "string",
    • "user_id": "string",
    • "session_id": "string",
    • "ssl": true,
    • "force_ssl": true,
    • "managed_dns": true,
    • "deploy_url": "string",
    • "published_deploy":
      {
      },
    • "account_name": "string",
    • "account_slug": "string",
    • "git_provider": "string",
    • "deploy_hook": "string",
    • "capabilities":
      {
      },
    • "processing_settings":
      {
      },
    • "build_settings":
      {
      },
    • "id_domain": "string",
    • "default_hooks_data":
      {
      },
    • "build_image": "string",
    • "prerender": "string"
    }

    createSiteInTeam

    Authorizations:
    netlifyAuth
    path Parameters
    account_slug
    required
    string
    query Parameters
    configure_dns
    boolean
    Request Body schema: application/json
    id
    string
    state
    string
    plan
    string
    name
    string
    custom_domain
    string
    domain_aliases
    Array of strings
    password
    string
    notification_email
    string
    url
    string
    ssl_url
    string
    admin_url
    string
    screenshot_url
    string
    created_at
    string <dateTime>
    updated_at
    string <dateTime>
    user_id
    string
    session_id
    string
    ssl
    boolean
    force_ssl
    boolean
    managed_dns
    boolean
    deploy_url
    string
    published_deploy
    object (deploy)
    account_name
    string
    account_slug
    string
    git_provider
    string
    deploy_hook
    string
    capabilities
    object
    processing_settings
    object
    build_settings
    object (repoInfo)
    id_domain
    string
    default_hooks_data
    object
    build_image
    string
    prerender
    string
    repo
    object (repoInfo)

    Responses

    201

    Created

    default

    error

    post /{account_slug}/sites
    https://api.netlify.com/api/v1/{account_slug}/sites

    Request samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "state": "string",
    • "plan": "string",
    • "name": "string",
    • "custom_domain": "string",
    • "domain_aliases":
      [
      ],
    • "password": "string",
    • "notification_email": "string",
    • "url": "string",
    • "ssl_url": "string",
    • "admin_url": "string",
    • "screenshot_url": "string",
    • "created_at": "string",
    • "updated_at": "string",
    • "user_id": "string",
    • "session_id": "string",
    • "ssl": true,
    • "force_ssl": true,
    • "managed_dns": true,
    • "deploy_url": "string",
    • "published_deploy":
      {
      },
    • "account_name": "string",
    • "account_slug": "string",
    • "git_provider": "string",
    • "deploy_hook": "string",
    • "capabilities":
      {
      },
    • "processing_settings":
      {
      },
    • "build_settings":
      {
      },
    • "id_domain": "string",
    • "default_hooks_data":
      {
      },
    • "build_image": "string",
    • "prerender": "string",
    • "repo":
      {
      }
    }

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "state": "string",
    • "plan": "string",
    • "name": "string",
    • "custom_domain": "string",
    • "domain_aliases":
      [
      ],
    • "password": "string",
    • "notification_email": "string",
    • "url": "string",
    • "ssl_url": "string",
    • "admin_url": "string",
    • "screenshot_url": "string",
    • "created_at": "string",
    • "updated_at": "string",
    • "user_id": "string",
    • "session_id": "string",
    • "ssl": true,
    • "force_ssl": true,
    • "managed_dns": true,
    • "deploy_url": "string",
    • "published_deploy":
      {
      },
    • "account_name": "string",
    • "account_slug": "string",
    • "git_provider": "string",
    • "deploy_hook": "string",
    • "capabilities":
      {
      },
    • "processing_settings":
      {
      },
    • "build_settings":
      {
      },
    • "id_domain": "string",
    • "default_hooks_data":
      {
      },
    • "build_image": "string",
    • "prerender": "string"
    }

    listSitesForAccount

    Authorizations:
    netlifyAuth
    path Parameters
    account_slug
    required
    string
    query Parameters
    name
    string
    page
    integer <int32>
    per_page
    integer <int32>

    Responses

    200

    OK

    default

    error

    get /{account_slug}/sites
    https://api.netlify.com/api/v1/{account_slug}/sites

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    [
    • {
      }
    ]

    File

    listSiteFiles

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string

    Responses

    200

    OK

    default

    error

    get /sites/{site_id}/files
    https://api.netlify.com/api/v1/sites/{site_id}/files

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    [
    • {
      }
    ]

    getSiteFileByPathName

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string
    file_path
    required
    string

    Responses

    200

    OK

    default

    error

    get /sites/{site_id}/files/{file_path}
    https://api.netlify.com/api/v1/sites/{site_id}/files/{file_path}

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "path": "string",
    • "sha": "string",
    • "mime_type": "string",
    • "size": 0
    }

    uploadDeployFile

    Authorizations:
    netlifyAuth
    path Parameters
    deploy_id
    required
    string
    path
    required
    string
    query Parameters
    size
    integer
    Request Body schema: application/octet-stream
    string <binary>

    Responses

    200

    OK

    default

    error

    put /deploys/{deploy_id}/files/{path}
    https://api.netlify.com/api/v1/deploys/{deploy_id}/files/{path}

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "path": "string",
    • "sha": "string",
    • "mime_type": "string",
    • "size": 0
    }

    Metadata

    getSiteMetadata

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string

    Responses

    200

    OK

    default

    error

    get /sites/{site_id}/metadata
    https://api.netlify.com/api/v1/sites/{site_id}/metadata

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    { }

    updateSiteMetadata

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string
    Request Body schema: application/json

    Responses

    204

    No content

    default

    error

    put /sites/{site_id}/metadata
    https://api.netlify.com/api/v1/sites/{site_id}/metadata

    Request samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    { }

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "code": 0,
    • "message": "string"
    }

    Snippet

    listSiteSnippets

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string

    Responses

    200

    OK

    default

    error

    get /sites/{site_id}/snippets
    https://api.netlify.com/api/v1/sites/{site_id}/snippets

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    [
    • {
      }
    ]

    createSiteSnippet

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string
    Request Body schema: application/json
    id
    integer <int32>
    site_id
    string
    title
    string
    general
    string
    general_position
    string
    goal
    string
    goal_position
    string

    Responses

    201

    OK

    default

    error

    post /sites/{site_id}/snippets
    https://api.netlify.com/api/v1/sites/{site_id}/snippets

    Request samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": 0,
    • "site_id": "string",
    • "title": "string",
    • "general": "string",
    • "general_position": "string",
    • "goal": "string",
    • "goal_position": "string"
    }

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": 0,
    • "site_id": "string",
    • "title": "string",
    • "general": "string",
    • "general_position": "string",
    • "goal": "string",
    • "goal_position": "string"
    }

    getSiteSnippet

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string
    snippet_id
    required
    string

    Responses

    200

    OK

    default

    error

    get /sites/{site_id}/snippets/{snippet_id}
    https://api.netlify.com/api/v1/sites/{site_id}/snippets/{snippet_id}

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": 0,
    • "site_id": "string",
    • "title": "string",
    • "general": "string",
    • "general_position": "string",
    • "goal": "string",
    • "goal_position": "string"
    }

    updateSiteSnippet

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string
    snippet_id
    required
    string
    Request Body schema: application/json
    id
    integer <int32>
    site_id
    string
    title
    string
    general
    string
    general_position
    string
    goal
    string
    goal_position
    string

    Responses

    204

    No content

    default

    error

    put /sites/{site_id}/snippets/{snippet_id}
    https://api.netlify.com/api/v1/sites/{site_id}/snippets/{snippet_id}

    Request samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": 0,
    • "site_id": "string",
    • "title": "string",
    • "general": "string",
    • "general_position": "string",
    • "goal": "string",
    • "goal_position": "string"
    }

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "code": 0,
    • "message": "string"
    }

    deleteSiteSnippet

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string
    snippet_id
    required
    string

    Responses

    204

    No content

    default

    error

    delete /sites/{site_id}/snippets/{snippet_id}
    https://api.netlify.com/api/v1/sites/{site_id}/snippets/{snippet_id}

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "code": 0,
    • "message": "string"
    }

    DNS zone

    getDNSForSite

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string

    Responses

    200

    OK

    default

    error

    get /sites/{site_id}/dns
    https://api.netlify.com/api/v1/sites/{site_id}/dns

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    [
    • {
      }
    ]

    configureDNSForSite

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string

    Responses

    200

    OK

    default

    error

    put /sites/{site_id}/dns
    https://api.netlify.com/api/v1/sites/{site_id}/dns

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    [
    • {
      }
    ]

    createDnsZone

    Authorizations:
    netlifyAuth
    Request Body schema: application/json
    account_slug
    string
    site_id
    string
    name
    string

    Responses

    201

    Created

    default

    error

    post /dns_zones
    https://api.netlify.com/api/v1/dns_zones

    Request samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "account_slug": "string",
    • "site_id": "string",
    • "name": "string"
    }

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "name": "string",
    • "errors":
      [
      ],
    • "supported_record_types":
      [
      ],
    • "user_id": "string",
    • "created_at": "string",
    • "updated_at": "string",
    • "records":
      [
      ],
    • "dns_servers":
      [
      ],
    • "account_id": "string",
    • "site_id": "string",
    • "account_slug": "string",
    • "account_name": "string",
    • "domain": "string",
    • "ipv6_enabled": true,
    • "dedicated": true
    }

    getDnsZones

    Authorizations:
    netlifyAuth
    query Parameters
    account_slug
    string

    Responses

    200

    get all DNS zones the user has access to

    default

    error

    get /dns_zones
    https://api.netlify.com/api/v1/dns_zones

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    [
    • {
      }
    ]

    getDnsZone

    Authorizations:
    netlifyAuth
    path Parameters
    zone_id
    required
    string

    Responses

    200

    get a single DNS zone

    default

    error

    get /dns_zones/{zone_id}
    https://api.netlify.com/api/v1/dns_zones/{zone_id}

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "name": "string",
    • "errors":
      [
      ],
    • "supported_record_types":
      [
      ],
    • "user_id": "string",
    • "created_at": "string",
    • "updated_at": "string",
    • "records":
      [
      ],
    • "dns_servers":
      [
      ],
    • "account_id": "string",
    • "site_id": "string",
    • "account_slug": "string",
    • "account_name": "string",
    • "domain": "string",
    • "ipv6_enabled": true,
    • "dedicated": true
    }

    deleteDnsZone

    Authorizations:
    netlifyAuth
    path Parameters
    zone_id
    required
    string

    Responses

    204

    delete a single DNS zone

    default

    error

    delete /dns_zones/{zone_id}
    https://api.netlify.com/api/v1/dns_zones/{zone_id}

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "code": 0,
    • "message": "string"
    }

    transferDnsZone

    Authorizations:
    netlifyAuth
    path Parameters
    zone_id
    required
    string
    query Parameters
    account_id
    required
    string

    the account of the dns zone

    transfer_account_id
    required
    string

    the account you want to transfer the dns zone to

    transfer_user_id
    required
    string

    the user you want to transfer the dns zone to

    Responses

    200

    transfer a DNS zone to another account

    default

    error

    put /dns_zones/{zone_id}/transfer
    https://api.netlify.com/api/v1/dns_zones/{zone_id}/transfer

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "name": "string",
    • "errors":
      [
      ],
    • "supported_record_types":
      [
      ],
    • "user_id": "string",
    • "created_at": "string",
    • "updated_at": "string",
    • "records":
      [
      ],
    • "dns_servers":
      [
      ],
    • "account_id": "string",
    • "site_id": "string",
    • "account_slug": "string",
    • "account_name": "string",
    • "domain": "string",
    • "ipv6_enabled": true,
    • "dedicated": true
    }

    getDnsRecords

    Authorizations:
    netlifyAuth
    path Parameters
    zone_id
    required
    string

    Responses

    200

    get all DNS records for a single DNS zone

    default

    error

    get /dns_zones/{zone_id}/dns_records
    https://api.netlify.com/api/v1/dns_zones/{zone_id}/dns_records

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    [
    • {
      }
    ]

    createDnsRecord

    Authorizations:
    netlifyAuth
    path Parameters
    zone_id
    required
    string
    Request Body schema: application/json
    type
    string
    hostname
    string
    value
    string
    ttl
    integer <int64>
    priority
    integer <int64>
    weight
    integer <int64>
    port
    integer <int64>
    flag
    integer <int64>
    tag
    string

    Responses

    201

    Created

    default

    error

    post /dns_zones/{zone_id}/dns_records
    https://api.netlify.com/api/v1/dns_zones/{zone_id}/dns_records

    Request samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "type": "string",
    • "hostname": "string",
    • "value": "string",
    • "ttl": 0,
    • "priority": 0,
    • "weight": 0,
    • "port": 0,
    • "flag": 0,
    • "tag": "string"
    }

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "hostname": "string",
    • "type": "string",
    • "value": "string",
    • "ttl": 0,
    • "priority": 0,
    • "dns_zone_id": "string",
    • "site_id": "string",
    • "flag": 0,
    • "tag": "string",
    • "managed": true
    }

    getIndividualDnsRecord

    Authorizations:
    netlifyAuth
    path Parameters
    zone_id
    required
    string
    dns_record_id
    required
    string

    Responses

    200

    get a single DNS record

    default

    error

    get /dns_zones/{zone_id}/dns_records/{dns_record_id}
    https://api.netlify.com/api/v1/dns_zones/{zone_id}/dns_records/{dns_record_id}

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "hostname": "string",
    • "type": "string",
    • "value": "string",
    • "ttl": 0,
    • "priority": 0,
    • "dns_zone_id": "string",
    • "site_id": "string",
    • "flag": 0,
    • "tag": "string",
    • "managed": true
    }

    deleteDnsRecord

    Authorizations:
    netlifyAuth
    path Parameters
    zone_id
    required
    string
    dns_record_id
    required
    string

    Responses

    204

    record deleted

    default

    error

    delete /dns_zones/{zone_id}/dns_records/{dns_record_id}
    https://api.netlify.com/api/v1/dns_zones/{zone_id}/dns_records/{dns_record_id}

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "code": 0,
    • "message": "string"
    }

    SNI certificate

    provisionSiteTLSCertificate

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string
    query Parameters
    certificate
    string
    key
    string
    ca_certificates
    string

    Responses

    200

    OK

    default

    error

    post /sites/{site_id}/ssl
    https://api.netlify.com/api/v1/sites/{site_id}/ssl

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "state": "string",
    • "domains":
      [
      ],
    • "created_at": "string",
    • "updated_at": "string",
    • "expires_at": "string"
    }

    showSiteTLSCertificate

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string

    Responses

    200

    OK

    default

    error

    get /sites/{site_id}/ssl
    https://api.netlify.com/api/v1/sites/{site_id}/ssl

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "state": "string",
    • "domains":
      [
      ],
    • "created_at": "string",
    • "updated_at": "string",
    • "expires_at": "string"
    }

    Deploy

    listSiteDeploys

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string
    query Parameters
    page
    integer <int32>
    per_page
    integer <int32>

    Responses

    200

    OK

    default

    error

    get /sites/{site_id}/deploys
    https://api.netlify.com/api/v1/sites/{site_id}/deploys

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    [
    • {
      }
    ]

    createSiteDeploy

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string
    query Parameters
    title
    string
    Request Body schema: application/json
    files
    object
    draft
    boolean
    async
    boolean
    functions
    object
    branch
    string
    framework
    string

    Responses

    200

    OK

    default

    error

    post /sites/{site_id}/deploys
    https://api.netlify.com/api/v1/sites/{site_id}/deploys

    Request samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "files": { },
    • "draft": true,
    • "async": true,
    • "functions": { },
    • "branch": "string",
    • "framework": "string"
    }

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "site_id": "string",
    • "user_id": "string",
    • "build_id": "string",
    • "state": "string",
    • "name": "string",
    • "url": "string",
    • "ssl_url": "string",
    • "admin_url": "string",
    • "deploy_url": "string",
    • "deploy_ssl_url": "string",
    • "screenshot_url": "string",
    • "review_id": 0,
    • "draft": true,
    • "required":
      [
      ],
    • "required_functions":
      [
      ],
    • "error_message": "string",
    • "branch": "string",
    • "commit_ref": "string",
    • "commit_url": "string",
    • "skipped": true,
    • "created_at": "string",
    • "updated_at": "string",
    • "published_at": "string",
    • "title": "string",
    • "context": "string",
    • "locked": true,
    • "review_url": "string",
    • "site_capabilities":
      {
      },
    • "framework": "string"
    }

    getSiteDeploy

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string
    deploy_id
    required
    string

    Responses

    200

    OK

    default

    error

    get /sites/{site_id}/deploys/{deploy_id}
    https://api.netlify.com/api/v1/sites/{site_id}/deploys/{deploy_id}

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "site_id": "string",
    • "user_id": "string",
    • "build_id": "string",
    • "state": "string",
    • "name": "string",
    • "url": "string",
    • "ssl_url": "string",
    • "admin_url": "string",
    • "deploy_url": "string",
    • "deploy_ssl_url": "string",
    • "screenshot_url": "string",
    • "review_id": 0,
    • "draft": true,
    • "required":
      [
      ],
    • "required_functions":
      [
      ],
    • "error_message": "string",
    • "branch": "string",
    • "commit_ref": "string",
    • "commit_url": "string",
    • "skipped": true,
    • "created_at": "string",
    • "updated_at": "string",
    • "published_at": "string",
    • "title": "string",
    • "context": "string",
    • "locked": true,
    • "review_url": "string",
    • "site_capabilities":
      {
      },
    • "framework": "string"
    }

    updateSiteDeploy

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string
    deploy_id
    required
    string
    Request Body schema: application/json
    files
    object
    draft
    boolean
    async
    boolean
    functions
    object
    branch
    string
    framework
    string

    Responses

    200

    OK

    default

    error

    put /sites/{site_id}/deploys/{deploy_id}
    https://api.netlify.com/api/v1/sites/{site_id}/deploys/{deploy_id}

    Request samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "files": { },
    • "draft": true,
    • "async": true,
    • "functions": { },
    • "branch": "string",
    • "framework": "string"
    }

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "site_id": "string",
    • "user_id": "string",
    • "build_id": "string",
    • "state": "string",
    • "name": "string",
    • "url": "string",
    • "ssl_url": "string",
    • "admin_url": "string",
    • "deploy_url": "string",
    • "deploy_ssl_url": "string",
    • "screenshot_url": "string",
    • "review_id": 0,
    • "draft": true,
    • "required":
      [
      ],
    • "required_functions":
      [
      ],
    • "error_message": "string",
    • "branch": "string",
    • "commit_ref": "string",
    • "commit_url": "string",
    • "skipped": true,
    • "created_at": "string",
    • "updated_at": "string",
    • "published_at": "string",
    • "title": "string",
    • "context": "string",
    • "locked": true,
    • "review_url": "string",
    • "site_capabilities":
      {
      },
    • "framework": "string"
    }

    cancelSiteDeploy

    Authorizations:
    netlifyAuth
    path Parameters
    deploy_id
    required
    string

    Responses

    201

    Cancelled

    default

    error

    post /deploys/{deploy_id}/cancel
    https://api.netlify.com/api/v1/deploys/{deploy_id}/cancel

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "site_id": "string",
    • "user_id": "string",
    • "build_id": "string",
    • "state": "string",
    • "name": "string",
    • "url": "string",
    • "ssl_url": "string",
    • "admin_url": "string",
    • "deploy_url": "string",
    • "deploy_ssl_url": "string",
    • "screenshot_url": "string",
    • "review_id": 0,
    • "draft": true,
    • "required":
      [
      ],
    • "required_functions":
      [
      ],
    • "error_message": "string",
    • "branch": "string",
    • "commit_ref": "string",
    • "commit_url": "string",
    • "skipped": true,
    • "created_at": "string",
    • "updated_at": "string",
    • "published_at": "string",
    • "title": "string",
    • "context": "string",
    • "locked": true,
    • "review_url": "string",
    • "site_capabilities":
      {
      },
    • "framework": "string"
    }

    restoreSiteDeploy

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string
    deploy_id
    required
    string

    Responses

    201

    Created

    default

    error

    post /sites/{site_id}/deploys/{deploy_id}/restore
    https://api.netlify.com/api/v1/sites/{site_id}/deploys/{deploy_id}/restore

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "site_id": "string",
    • "user_id": "string",
    • "build_id": "string",
    • "state": "string",
    • "name": "string",
    • "url": "string",
    • "ssl_url": "string",
    • "admin_url": "string",
    • "deploy_url": "string",
    • "deploy_ssl_url": "string",
    • "screenshot_url": "string",
    • "review_id": 0,
    • "draft": true,
    • "required":
      [
      ],
    • "required_functions":
      [
      ],
    • "error_message": "string",
    • "branch": "string",
    • "commit_ref": "string",
    • "commit_url": "string",
    • "skipped": true,
    • "created_at": "string",
    • "updated_at": "string",
    • "published_at": "string",
    • "title": "string",
    • "context": "string",
    • "locked": true,
    • "review_url": "string",
    • "site_capabilities":
      {
      },
    • "framework": "string"
    }

    rollbackSiteDeploy

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string

    Responses

    204

    No content

    default

    error

    post /sites/{site_id}/rollback
    https://api.netlify.com/api/v1/sites/{site_id}/rollback

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "code": 0,
    • "message": "string"
    }

    getDeploy

    Authorizations:
    netlifyAuth
    path Parameters
    deploy_id
    required
    string

    Responses

    200

    OK

    default

    error

    get /deploys/{deploy_id}
    https://api.netlify.com/api/v1/deploys/{deploy_id}

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "site_id": "string",
    • "user_id": "string",
    • "build_id": "string",
    • "state": "string",
    • "name": "string",
    • "url": "string",
    • "ssl_url": "string",
    • "admin_url": "string",
    • "deploy_url": "string",
    • "deploy_ssl_url": "string",
    • "screenshot_url": "string",
    • "review_id": 0,
    • "draft": true,
    • "required":
      [
      ],
    • "required_functions":
      [
      ],
    • "error_message": "string",
    • "branch": "string",
    • "commit_ref": "string",
    • "commit_url": "string",
    • "skipped": true,
    • "created_at": "string",
    • "updated_at": "string",
    • "published_at": "string",
    • "title": "string",
    • "context": "string",
    • "locked": true,
    • "review_url": "string",
    • "site_capabilities":
      {
      },
    • "framework": "string"
    }

    lockDeploy

    Authorizations:
    netlifyAuth
    path Parameters
    deploy_id
    required
    string

    Responses

    200

    OK

    default

    error

    post /deploys/{deploy_id}/lock
    https://api.netlify.com/api/v1/deploys/{deploy_id}/lock

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "site_id": "string",
    • "user_id": "string",
    • "build_id": "string",
    • "state": "string",
    • "name": "string",
    • "url": "string",
    • "ssl_url": "string",
    • "admin_url": "string",
    • "deploy_url": "string",
    • "deploy_ssl_url": "string",
    • "screenshot_url": "string",
    • "review_id": 0,
    • "draft": true,
    • "required":
      [
      ],
    • "required_functions":
      [
      ],
    • "error_message": "string",
    • "branch": "string",
    • "commit_ref": "string",
    • "commit_url": "string",
    • "skipped": true,
    • "created_at": "string",
    • "updated_at": "string",
    • "published_at": "string",
    • "title": "string",
    • "context": "string",
    • "locked": true,
    • "review_url": "string",
    • "site_capabilities":
      {
      },
    • "framework": "string"
    }

    unlockDeploy

    Authorizations:
    netlifyAuth
    path Parameters
    deploy_id
    required
    string

    Responses

    200

    OK

    default

    error

    post /deploys/{deploy_id}/unlock
    https://api.netlify.com/api/v1/deploys/{deploy_id}/unlock

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "site_id": "string",
    • "user_id": "string",
    • "build_id": "string",
    • "state": "string",
    • "name": "string",
    • "url": "string",
    • "ssl_url": "string",
    • "admin_url": "string",
    • "deploy_url": "string",
    • "deploy_ssl_url": "string",
    • "screenshot_url": "string",
    • "review_id": 0,
    • "draft": true,
    • "required":
      [
      ],
    • "required_functions":
      [
      ],
    • "error_message": "string",
    • "branch": "string",
    • "commit_ref": "string",
    • "commit_url": "string",
    • "skipped": true,
    • "created_at": "string",
    • "updated_at": "string",
    • "published_at": "string",
    • "title": "string",
    • "context": "string",
    • "locked": true,
    • "review_url": "string",
    • "site_capabilities":
      {
      },
    • "framework": "string"
    }

    Deployed branch

    listSiteDeployedBranches

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string

    Responses

    200

    OK

    default

    error

    get /sites/{site_id}/deployed-branches
    https://api.netlify.com/api/v1/sites/{site_id}/deployed-branches

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    [
    • {
      }
    ]

    Deploy key

    listDeployKeys

    Authorizations:
    netlifyAuth

    Responses

    200

    OK

    default

    error

    get /deploy_keys
    https://api.netlify.com/api/v1/deploy_keys

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    [
    • {
      }
    ]

    createDeployKey

    Authorizations:
    netlifyAuth

    Responses

    201

    Created

    default

    error

    post /deploy_keys
    https://api.netlify.com/api/v1/deploy_keys

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "public_key": "string",
    • "created_at": "string"
    }

    getDeployKey

    Authorizations:
    netlifyAuth
    path Parameters
    key_id
    required
    string

    Responses

    200

    OK

    default

    error

    get /deploy_keys/{key_id}
    https://api.netlify.com/api/v1/deploy_keys/{key_id}

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "public_key": "string",
    • "created_at": "string"
    }

    deleteDeployKey

    Authorizations:
    netlifyAuth
    path Parameters
    key_id
    required
    string

    Responses

    204

    Not Content

    default

    error

    delete /deploy_keys/{key_id}
    https://api.netlify.com/api/v1/deploy_keys/{key_id}

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "code": 0,
    • "message": "string"
    }

    Build

    listSiteBuilds

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string
    query Parameters
    page
    integer <int32>
    per_page
    integer <int32>

    Responses

    200

    OK

    default

    error

    get /sites/{site_id}/builds
    https://api.netlify.com/api/v1/sites/{site_id}/builds

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    [
    • {
      }
    ]

    createSiteBuild

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string

    Responses

    200

    OK

    default

    error

    post /sites/{site_id}/builds
    https://api.netlify.com/api/v1/sites/{site_id}/builds

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "deploy_id": "string",
    • "sha": "string",
    • "done": true,
    • "error": "string",
    • "created_at": "string"
    }

    getSiteBuild

    Authorizations:
    netlifyAuth
    path Parameters
    build_id
    required
    string

    Responses

    200

    OK

    default

    error

    get /builds/{build_id}
    https://api.netlify.com/api/v1/builds/{build_id}

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "deploy_id": "string",
    • "sha": "string",
    • "done": true,
    • "error": "string",
    • "created_at": "string"
    }

    notifyBuildStart

    Authorizations:
    netlifyAuth
    path Parameters
    build_id
    required
    string

    Responses

    204

    No content

    default

    error

    post /builds/{build_id}/start
    https://api.netlify.com/api/v1/builds/{build_id}/start

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "code": 0,
    • "message": "string"
    }

    getAccountBuildStatus

    Authorizations:
    netlifyAuth
    path Parameters
    account_id
    required
    string

    Responses

    200

    OK

    default

    error

    get /{account_id}/builds/status
    https://api.netlify.com/api/v1/{account_id}/builds/status

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    [
    • {
      }
    ]

    Build log message

    updateSiteBuildLog

    Authorizations:
    netlifyAuth
    path Parameters
    build_id
    required
    string

    Responses

    204

    No content

    default

    error

    post /builds/{build_id}/log
    https://api.netlify.com/api/v1/builds/{build_id}/log

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "code": 0,
    • "message": "string"
    }

    Hook

    listHooksBySiteId

    Authorizations:
    netlifyAuth
    query Parameters
    site_id
    required
    string

    Responses

    200

    OK

    default

    error

    get /hooks
    https://api.netlify.com/api/v1/hooks

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    [
    • {
      }
    ]

    createHookBySiteId

    Authorizations:
    netlifyAuth
    query Parameters
    site_id
    required
    string
    Request Body schema: application/json
    id
    string
    site_id
    string
    type
    string
    event
    string
    data
    object
    created_at
    string <dateTime>
    updated_at
    string <dateTime>
    disabled
    boolean

    Responses

    201

    OK

    default

    error

    post /hooks
    https://api.netlify.com/api/v1/hooks

    Request samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "site_id": "string",
    • "type": "string",
    • "event": "string",
    • "data": { },
    • "created_at": "string",
    • "updated_at": "string",
    • "disabled": true
    }

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "site_id": "string",
    • "type": "string",
    • "event": "string",
    • "data": { },
    • "created_at": "string",
    • "updated_at": "string",
    • "disabled": true
    }

    getHook

    Authorizations:
    netlifyAuth
    path Parameters
    hook_id
    required
    string

    Responses

    200

    OK

    default

    error

    get /hooks/{hook_id}
    https://api.netlify.com/api/v1/hooks/{hook_id}

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "site_id": "string",
    • "type": "string",
    • "event": "string",
    • "data": { },
    • "created_at": "string",
    • "updated_at": "string",
    • "disabled": true
    }

    updateHook

    Authorizations:
    netlifyAuth
    path Parameters
    hook_id
    required
    string
    Request Body schema: application/json
    id
    string
    site_id
    string
    type
    string
    event
    string
    data
    object
    created_at
    string <dateTime>
    updated_at
    string <dateTime>
    disabled
    boolean

    Responses

    200

    OK

    default

    error

    put /hooks/{hook_id}
    https://api.netlify.com/api/v1/hooks/{hook_id}

    Request samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "site_id": "string",
    • "type": "string",
    • "event": "string",
    • "data": { },
    • "created_at": "string",
    • "updated_at": "string",
    • "disabled": true
    }

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "site_id": "string",
    • "type": "string",
    • "event": "string",
    • "data": { },
    • "created_at": "string",
    • "updated_at": "string",
    • "disabled": true
    }

    deleteHook

    Authorizations:
    netlifyAuth
    path Parameters
    hook_id
    required
    string

    Responses

    204

    No content

    delete /hooks/{hook_id}
    https://api.netlify.com/api/v1/hooks/{hook_id}

    enableHook

    Authorizations:
    netlifyAuth
    path Parameters
    hook_id
    required
    string

    Responses

    200

    OK

    default

    error

    post /hooks/{hook_id}/enable
    https://api.netlify.com/api/v1/hooks/{hook_id}/enable

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "site_id": "string",
    • "type": "string",
    • "event": "string",
    • "data": { },
    • "created_at": "string",
    • "updated_at": "string",
    • "disabled": true
    }

    Hook type

    listHookTypes

    Authorizations:
    netlifyAuth

    Responses

    200

    OK

    default

    error

    get /hooks/types
    https://api.netlify.com/api/v1/hooks/types

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    [
    • {
      }
    ]

    Build hook

    listSiteBuildHooks

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string

    Responses

    200

    OK

    default

    error

    get /sites/{site_id}/build_hooks
    https://api.netlify.com/api/v1/sites/{site_id}/build_hooks

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    [
    • {
      }
    ]

    createSiteBuildHook

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string
    Request Body schema: application/json
    title
    string
    branch
    string

    Responses

    201

    Created

    default

    error

    post /sites/{site_id}/build_hooks
    https://api.netlify.com/api/v1/sites/{site_id}/build_hooks

    Request samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "title": "string",
    • "branch": "string"
    }

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "title": "string",
    • "branch": "string",
    • "url": "string",
    • "site_id": "string",
    • "created_at": "string"
    }

    getSiteBuildHook

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string
    id
    required
    string

    Responses

    200

    OK

    default

    error

    get /sites/{site_id}/build_hooks/{id}
    https://api.netlify.com/api/v1/sites/{site_id}/build_hooks/{id}

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "title": "string",
    • "branch": "string",
    • "url": "string",
    • "site_id": "string",
    • "created_at": "string"
    }

    updateSiteBuildHook

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string
    id
    required
    string
    Request Body schema: application/json
    title
    string
    branch
    string

    Responses

    204

    No content

    default

    error

    put /sites/{site_id}/build_hooks/{id}
    https://api.netlify.com/api/v1/sites/{site_id}/build_hooks/{id}

    Request samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "title": "string",
    • "branch": "string"
    }

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "code": 0,
    • "message": "string"
    }

    deleteSiteBuildHook

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string
    id
    required
    string

    Responses

    204

    No content

    default

    error

    delete /sites/{site_id}/build_hooks/{id}
    https://api.netlify.com/api/v1/sites/{site_id}/build_hooks/{id}

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "code": 0,
    • "message": "string"
    }

    Service

    getServices

    Authorizations:
    netlifyAuth
    query Parameters
    search
    string

    Responses

    200

    services

    default

    error

    get /services/
    https://api.netlify.com/api/v1/services/

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    [
    • {
      }
    ]

    showService

    Authorizations:
    netlifyAuth
    path Parameters
    addonName
    required
    string

    Responses

    200

    services

    default

    error

    get /services/{addonName}
    https://api.netlify.com/api/v1/services/{addonName}

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "name": "string",
    • "slug": "string",
    • "service_path": "string",
    • "long_description": "string",
    • "description": "string",
    • "events":
      [
      ],
    • "tags":
      [
      ],
    • "icon": "string",
    • "manifest_url": "string",
    • "environments":
      [
      ],
    • "created_at": "string",
    • "updated_at": "string"
    }

    showServiceManifest

    Authorizations:
    netlifyAuth
    path Parameters
    addonName
    required
    string

    Responses

    201

    retrieving from provider

    default

    error

    get /services/{addonName}/manifest
    https://api.netlify.com/api/v1/services/{addonName}/manifest

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    { }

    Service instance

    listServiceInstancesForSite

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string

    Responses

    200

    OK

    default

    error

    get /sites/{site_id}/service-instances
    https://api.netlify.com/api/v1/sites/{site_id}/service-instances

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    [
    • {
      }
    ]

    createServiceInstance

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string
    addon
    required
    string
    Request Body schema: application/json

    Responses

    201

    Created

    default

    error

    post /sites/{site_id}/services/{addon}/instances
    https://api.netlify.com/api/v1/sites/{site_id}/services/{addon}/instances

    Request samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    { }

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "url": "string",
    • "config": { },
    • "external_attributes": { },
    • "service_slug": "string",
    • "service_path": "string",
    • "service_name": "string",
    • "env": { },
    • "snippets":
      [
      ],
    • "auth_url": "string",
    • "created_at": "string",
    • "updated_at": "string"
    }

    showServiceInstance

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string
    addon
    required
    string
    instance_id
    required
    string

    Responses

    200

    OK

    default

    error

    get /sites/{site_id}/services/{addon}/instances/{instance_id}
    https://api.netlify.com/api/v1/sites/{site_id}/services/{addon}/instances/{instance_id}

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "url": "string",
    • "config": { },
    • "external_attributes": { },
    • "service_slug": "string",
    • "service_path": "string",
    • "service_name": "string",
    • "env": { },
    • "snippets":
      [
      ],
    • "auth_url": "string",
    • "created_at": "string",
    • "updated_at": "string"
    }

    updateServiceInstance

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string
    addon
    required
    string
    instance_id
    required
    string
    Request Body schema: application/json

    Responses

    204

    No Content

    default

    error

    put /sites/{site_id}/services/{addon}/instances/{instance_id}
    https://api.netlify.com/api/v1/sites/{site_id}/services/{addon}/instances/{instance_id}

    Request samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    { }

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "code": 0,
    • "message": "string"
    }

    deleteServiceInstance

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string
    addon
    required
    string
    instance_id
    required
    string

    Responses

    204

    Deleted

    default

    error

    delete /sites/{site_id}/services/{addon}/instances/{instance_id}
    https://api.netlify.com/api/v1/sites/{site_id}/services/{addon}/instances/{instance_id}

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "code": 0,
    • "message": "string"
    }

    Function

    uploadDeployFunction

    Authorizations:
    netlifyAuth
    path Parameters
    deploy_id
    required
    string
    name
    required
    string
    query Parameters
    runtime
    string
    size
    integer
    Request Body schema: application/octet-stream
    string <binary>

    Responses

    200

    OK

    default

    error

    put /deploys/{deploy_id}/functions/{name}
    https://api.netlify.com/api/v1/deploys/{deploy_id}/functions/{name}

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "name": "string",
    • "sha": "string"
    }

    Form

    listSiteForms

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string

    Responses

    200

    OK

    default

    error

    get /sites/{site_id}/forms
    https://api.netlify.com/api/v1/sites/{site_id}/forms

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    [
    • {
      }
    ]

    deleteSiteForm

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string
    form_id
    required
    string

    Responses

    204

    Deleted

    default

    error

    delete /sites/{site_id}/forms/{form_id}
    https://api.netlify.com/api/v1/sites/{site_id}/forms/{form_id}

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "code": 0,
    • "message": "string"
    }

    Form submission

    listSiteSubmissions

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string
    query Parameters
    page
    integer <int32>
    per_page
    integer <int32>

    Responses

    200

    OK

    default

    error

    get /sites/{site_id}/submissions
    https://api.netlify.com/api/v1/sites/{site_id}/submissions

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    [
    • {
      }
    ]

    listFormSubmissions

    Authorizations:
    netlifyAuth
    path Parameters
    form_id
    required
    string
    query Parameters
    page
    integer <int32>
    per_page
    integer <int32>

    Responses

    200

    OK

    default

    error

    get /forms/{form_id}/submissions
    https://api.netlify.com/api/v1/forms/{form_id}/submissions

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    [
    • {
      }
    ]

    listFormSubmission

    Authorizations:
    netlifyAuth
    path Parameters
    submission_id
    required
    string
    query Parameters
    query
    string
    page
    integer <int32>
    per_page
    integer <int32>

    Responses

    200

    OK

    default

    error

    get /submissions/{submission_id}
    https://api.netlify.com/api/v1/submissions/{submission_id}

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    [
    • {
      }
    ]

    deleteSubmission

    Authorizations:
    netlifyAuth
    path Parameters
    submission_id
    required
    string

    Responses

    204

    Deleted

    default

    error

    delete /submissions/{submission_id}
    https://api.netlify.com/api/v1/submissions/{submission_id}

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "code": 0,
    • "message": "string"
    }

    Split test

    createSplitTest

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string
    Request Body schema: application/json
    branch_tests
    object

    Responses

    201

    Created

    default

    error

    post /sites/{site_id}/traffic_splits
    https://api.netlify.com/api/v1/sites/{site_id}/traffic_splits

    Request samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "branch_tests": { }
    }

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "site_id": "string",
    • "name": "string",
    • "path": "string",
    • "branches":
      [
      ],
    • "active": true,
    • "created_at": "string",
    • "updated_at": "string",
    • "unpublished_at": "string"
    }

    getSplitTests

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string

    Responses

    200

    split_tests

    default

    error

    get /sites/{site_id}/traffic_splits
    https://api.netlify.com/api/v1/sites/{site_id}/traffic_splits

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    [
    • {
      }
    ]

    updateSplitTest

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string
    split_test_id
    required
    string
    Request Body schema: application/json
    branch_tests
    object

    Responses

    201

    Created

    default

    error

    put /sites/{site_id}/traffic_splits/{split_test_id}
    https://api.netlify.com/api/v1/sites/{site_id}/traffic_splits/{split_test_id}

    Request samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "branch_tests": { }
    }

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "site_id": "string",
    • "name": "string",
    • "path": "string",
    • "branches":
      [
      ],
    • "active": true,
    • "created_at": "string",
    • "updated_at": "string",
    • "unpublished_at": "string"
    }

    getSplitTest

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string
    split_test_id
    required
    string

    Responses

    200

    split_test

    default

    error

    get /sites/{site_id}/traffic_splits/{split_test_id}
    https://api.netlify.com/api/v1/sites/{site_id}/traffic_splits/{split_test_id}

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "site_id": "string",
    • "name": "string",
    • "path": "string",
    • "branches":
      [
      ],
    • "active": true,
    • "created_at": "string",
    • "updated_at": "string",
    • "unpublished_at": "string"
    }

    enableSplitTest

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string
    split_test_id
    required
    string

    Responses

    204

    enable

    default

    error

    post /sites/{site_id}/traffic_splits/{split_test_id}/publish
    https://api.netlify.com/api/v1/sites/{site_id}/traffic_splits/{split_test_id}/publish

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "code": 0,
    • "message": "string"
    }

    disableSplitTest

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string
    split_test_id
    required
    string

    Responses

    204

    disabled

    default

    error

    post /sites/{site_id}/traffic_splits/{split_test_id}/unpublish
    https://api.netlify.com/api/v1/sites/{site_id}/traffic_splits/{split_test_id}/unpublish

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "code": 0,
    • "message": "string"
    }

    Asset

    listSiteAssets

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string

    Responses

    200

    OK

    default

    error

    get /sites/{site_id}/assets
    https://api.netlify.com/api/v1/sites/{site_id}/assets

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    [
    • {
      }
    ]

    createSiteAsset

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string
    query Parameters
    name
    required
    string
    size
    required
    integer <int64>
    content_type
    required
    string
    visibility
    string

    Responses

    201

    Created

    default

    error

    post /sites/{site_id}/assets
    https://api.netlify.com/api/v1/sites/{site_id}/assets

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "form":
      {
      },
    • "asset":
      {
      }
    }

    getSiteAssetInfo

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string
    asset_id
    required
    string

    Responses

    200

    OK

    default

    error

    get /sites/{site_id}/assets/{asset_id}
    https://api.netlify.com/api/v1/sites/{site_id}/assets/{asset_id}

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "site_id": "string",
    • "creator_id": "string",
    • "name": "string",
    • "state": "string",
    • "content_type": "string",
    • "url": "string",
    • "key": "string",
    • "visibility": "string",
    • "size": 0,
    • "created_at": "string",
    • "updated_at": "string"
    }

    updateSiteAsset

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string
    asset_id
    required
    string
    query Parameters
    state
    required
    string

    Responses

    200

    Updated

    default

    error

    put /sites/{site_id}/assets/{asset_id}
    https://api.netlify.com/api/v1/sites/{site_id}/assets/{asset_id}

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "site_id": "string",
    • "creator_id": "string",
    • "name": "string",
    • "state": "string",
    • "content_type": "string",
    • "url": "string",
    • "key": "string",
    • "visibility": "string",
    • "size": 0,
    • "created_at": "string",
    • "updated_at": "string"
    }

    deleteSiteAsset

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string
    asset_id
    required
    string

    Responses

    204

    Deleted

    default

    error

    delete /sites/{site_id}/assets/{asset_id}
    https://api.netlify.com/api/v1/sites/{site_id}/assets/{asset_id}

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "code": 0,
    • "message": "string"
    }

    Asset public signature

    getSiteAssetPublicSignature

    Authorizations:
    netlifyAuth
    path Parameters
    site_id
    required
    string
    asset_id
    required
    string

    Responses

    200

    OK

    default

    error

    get /sites/{site_id}/assets/{asset_id}/public_signature
    https://api.netlify.com/api/v1/sites/{site_id}/assets/{asset_id}/public_signature

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "url": "string"
    }