Header

Create an excluded file via API

This method allows you to add a new excluded file to an existing project.

URL

/projects/<permalink>/excluded_files
  • Replace <permalink> with the permalink of your project.

HTTP Method

POST

Supported Parameters

  • path - the full path for the excluded file (required)
  • servers - an array of server identifiers to apply the excluded file rule to (optional)
  • all_servers - If the excluded file rule should apply to all servers set to true, otherwise send an array of server_identifiers (optional)

Example cURL Request

curl -H "Content-type: application/json" \
-H "Accept: application/json" \
--user adam@atechmedia.com:my-api-key \
-X POST \
-d '{ \
  "config_file":{ \
    "path":"node_modules/**", \ 
    "servers":[] \
  } \
}' \
https://atech.deployhq.com/projects/api-created/excluded_files

Example response

{
  "identifier":"ade7a338-c326-4a0c-9010-262541894656",
  "path":"node_modules/**",
  "servers":[]
}
Tree

Proudly powered by Katapult. Running on 100% renewable energy.