Api documentation

Credentials

In order to make a call to our api, you need to authenticate with your api key and api secret credentials. You can see your own api credentials on your profile page.

You can download an "out of the box working" php client for our api thanks to Rutger Kirkels.

Get languages list

Url

https://codedump.io/api/languages/get

Method

POST

Response format

JSON

Parameters

parameter remark
token_key api key that is provided on your profile page
token_secret api secret that is provided on your profile page

Response

code message remark
200 Ok List of available languages
400 Fail Bad request (no POST)
401 Fail Unauthorized
406 Fail Missing parameter
407 Fail Incorrect parameter value

Remark

Provides a list of all available languages to send as a parameter to create a codedump.

Get access list

Url

https://codedump.io/api/access/get

Method

POST

Response format

JSON

Parameters

parameter remark
token_key api key that is provided on your profile page
token_secret api secret that is provided on your profile page

Response

code message remark
200 Ok List of available access parameters
400 Fail Bad request (no POST)
401 Fail Unauthorized
406 Fail Missing parameter
407 Fail Incorrect parameter value

Remark

Provides a list of all available access parameters to send as a parameter to create a codedump.

Create codedump

Url

https://codedump.io/api/code/add

Method

POST

Response format

JSON

Parameters

parameter remark
token_key api key that is provided on your profile page
token_secret api secret that is provided on your profile page
title title of the codedump
description description of the codedump
code code for the codedump
access access public or private, see: get access parameters
language code language, see: get languages parameters

Response

code message remark
200 Ok Code share link
400 Fail Bad request (no POST)
401 Fail Unauthorized
406 Fail Missing parameter
407 Fail Incorrect parameter value

Remark

Creates a new codedump. Will return a share link.

Get my codedumps

Url

https://codedump.io/api/dumps/get

Method

POST

Response format

JSON

Parameters

parameter remark
token_key api key that is provided on your profile page
token_secret api secret that is provided on your profile page

Response

code message remark
200 Ok List of codedumps you created (title, link, version, views, mailed and forks)
400 Fail Bad request (no POST)
401 Fail Unauthorized
406 Fail Missing parameter
407 Fail Incorrect parameter value

Remark

Returns a dump list (title, link, version, views, mailed and forks) of all your created codedumps (sorted by date with last created first).

Get a specific codedump

Url

https://codedump.io/api/dump/get

Method

POST

Response format

JSON

Parameters

parameter remark
token_key api key that is provided on your profile page
token_secret api secret that is provided on your profile page
link Fully link generated on the codedump.io website (for example: https://codedump.io/share/swStxRcgUfd)

Response

code message remark
200 Ok Codedump you created (title, link, code, version, views, mailed and forks)
400 Fail Bad request (no POST)
401 Fail Unauthorized
406 Fail Missing parameter
407 Fail Incorrect parameter value

Remark

Returns a codedump you created (title, link, code, version, views, mailed and forks)